Skip to the content

Remove an enrollment

POST /v1/campaigns/{campaign_id}/contacts/{enrollment_id}/remove

Property	Value
Operation	`remove_campaign_enrollment`
Group	Campaigns
Scope	`campaigns:write`
Route class	`control`
Idempotency	`Idempotency-Key` accepted: a retry with the same key replays the first answer
Audit	Audited `campaigns.enrollment.remove` (mutation)
Released in	1.65.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Removes an enrollment and answers it removed (1.65.0; section 9): its contact instance is cancelled through an enrollment.removed Process event, a live Call finishes, and no later attempt starts; an Audit event. One already removed is answered as it stands; one that ended otherwise is campaign_conflict (enrollment_ended).

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the campaigns:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/campaigns/cmp_.../contacts/cen_.../remove" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/campaigns/cmp_.../contacts/cen_.../remove`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/campaigns/cmp_.../contacts/cen_.../remove",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`campaign_id`	path	CampaignId	yes	The id of a Campaign: `cmp_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`enrollment_id`	path	CampaignEnrollmentId	yes	The id of the enrollment of one Contact in a Campaign: `cen_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`idempotency-key`	header	string	no	A client-chosen key, kept 24 hours per Organization, environment and route. A replay returns the stored response.

Request body

Content type application/json, required: CampaignEnrollmentRemoveRequest.

Field	Type	Required	Description
`reason`	string	no	A snake_case code the Audit event records; never free text.

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	CampaignEnrollment
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`, `org_suspended`
`404`	`application/json`	ErrorEnvelope	`not_found`
`409`	`application/json`	ErrorEnvelope	`campaign_conflict`, `idempotency_in_progress`, `idempotency_key_reused`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is CampaignEnrollment.

Field	Type	Required	Description
`all_attempts`	integer	yes	Every attempt, those that never rang included.
`arm`	CampaignArmKey	yes
`attempts`	integer	yes	Attempts that reached `ringing`.
`campaign_id`	CampaignId	yes
`completed_at`	Timestamp or null	yes
`contact_id`	ContactId	yes
`created_at`	Timestamp	yes
`disposition`	CampaignDisposition or null	yes	The terminal disposition of a `completed` enrollment; null otherwise.
`id`	CampaignEnrollmentId	yes
`ineligible_code`	CampaignIneligibleCode or null	yes
`last_call_id`	CallId or null	yes
`last_ended_reason`	EndedReason or null	yes
`live_call_id`	CallId or null	yes
`next_attempt_at`	Timestamp or null	yes
`object`	`"campaign_enrollment"`	yes
`outcome_id`	OutcomeId or null	yes
`phone_number_id`	PhoneNumberId or null	yes	The number assigned at the first permit, sticky for the enrollment.
`priority`	integer	yes
`process_id`	ProcessInstanceId or null	yes	The contact instance, started with the first permit; null before it.
`status`	CampaignEnrollmentStatus	yes
`variables`	object or null	yes	Per-enrollment variables. Content; null unless the read names `include=content`.