curl --request POST \
--url https://api.stardex.ai/v1/campaigns/{id}/enrollments/stop \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enrollment_ids": [
"e7b1d3f5-9a2c-4e6b-8d0f-3a5c7e9b1d42",
"f3a5c7e9-1b3d-4f6a-8c2e-4d6f8a0c2e57"
]
}
'{
"success": true,
"data": {
"stopped_enrollment_count": 2
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Campaigns
Stop enrollees
Stops up to 500 enrollees of this campaign by enrollment id, or everyone one enrollment batch enrolled (batch_id), which undoes its start. Pass one of the two. People who already replied, booked a meeting, finished or were stopped are left as they are and not counted. Needs campaigns:enroll.
POST
/
v1
/
campaigns
/
{id}
/
enrollments
/
stop
curl --request POST \
--url https://api.stardex.ai/v1/campaigns/{id}/enrollments/stop \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enrollment_ids": [
"e7b1d3f5-9a2c-4e6b-8d0f-3a5c7e9b1d42",
"f3a5c7e9-1b3d-4f6a-8c2e-4d6f8a0c2e57"
]
}
'{
"success": true,
"data": {
"stopped_enrollment_count": 2
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
Authenticate with a Bearer token: API key, OAuth token, or session token.
Path Parameters
Campaign ID.
Body
application/json
Was this page helpful?