Skip to main content
POST
upload an audience

Authorizations

Authorization
string
header
required

your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.

Body

multipart/form-data

the multipart form of POST /v1/campaign-audiences.

file
file | null

the CSV: .csv / .tsv / .txt, up to 10 MB and 10,000 rows, first row = header.

name
string | null

the audience's name, up to 120 characters.

phoneColumn
string | null

the header of the column with the phone numbers (case-insensitive).

defaultCountryCode
string | null

added to numbers without a country code. default +91.

contextColumns
string | null

a JSON string: [{"column": "city", "description": "where they live"}] — the columns the agent is given for each person. left out, every column.

Response

created.

a contact list (CSV) a campaign calls, with the columns its agent gets.

id
string<uuid>
required
name
string
required
columns
string[]
required
phoneColumn
string
required
contactCount
integer
required
skippedCount
integer
required
sourceFilename
string | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
contextColumns
ContextColumn · object[] | null