Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

Agent id.

Minimum string length: 1

Query Parameters

locationId
string

Pair with campaignId; omit both for primary campaign.

Minimum string length: 1
campaignId
string

Pair with locationId; omit both for primary campaign.

Minimum string length: 1

Body

application/json
dryRun
boolean
default:true
Example:

true

limit
integer
default:1000
Required range: 1 <= x <= 5000
Example:

1000

Response

Enrollment preview or result.

success
boolean
required
data
object
required