Skip to main content
POST
Add Targets

Path Parameters

campaign_id
string
required

The ID of the campaign to add targets to.

Body

application/json
targets
TargetInput · object[] | null

The list of targets as TargetInputs

Example:
launch
boolean
default:false

Whether to launch the targets immediately or only add them to the campaign

call_immediately
boolean
default:false

Only used together with launch. Dial these targets as soon as they are queued, on an already running agent, instead of on the next dispatch with a freshly started one. Best effort: the campaign's calling hours still apply, a call falls back to a freshly started agent when none is idle, and it has no effect on payor campaigns. Meant for a handful of calls someone is waiting on, such as a demo.

allow_duplicates
boolean
default:true

When set to True all targets with and external ID already contained in the campaign will be ignored

strict
boolean
default:true

When set to False, targets that fail validation are still uploaded; targets with an invalid phone number are marked as INVALID_PHONE_NUMBER when the call is about to be executed

Response

Successful Response