Skip to main content
POST
Add contacts to a campaign

Authorizations

API-Token
string
header
required

16-character API token associated with your OSVI account. Find it in your dashboard under Settings → API.

Path Parameters

id
integer
required

The campaign's numeric id.

Body

application/json
agent_uuid
string
required

The agent that will place the calls.

Example:

"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og"

contacts
object[]
required

Up to 10,000 contacts per request. Split larger imports across multiple requests.

enqueue
boolean
default:false

Release the contacts to the calling queue immediately.

Example:

false

Response

Contacts stored (and enqueued when requested).

success
boolean
Example:

true

data
object