Campaign Enrollment

Change customer campaign status

Mark customers in a campaign as completed, failed, or cancelled. Requires campaign_enrollment.manage. Provide customer or customers (up to 1,000), identified by customerId or US phoneNumber. Returns HTTP 202 with a server-generated job ID for both individuals and lists. Invalid customer entries fail individually with invalid_customer_reference and validationErrors; valid entries continue. Invalid request structure still returns 422. Poll statusUrl for per-input results. An optional idempotencyKey protects retries of the same payload; without one, each submission creates a new request. Customers must already exist in your organization. See Campaign API guide for restrictions and retries. This stops future campaign outreach, but does not hang up a call in progress or cancel appointments. Customers who are not in the campaign are skipped.

post/v2/campaigns/{campaignId}/enrollment/status

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/campaigns/{campaignId}/enrollment/status
  • Auth
    API key in header x-api-key

Path parameters

campaignIdstring uuid required

POST /v2/campaigns/:campaignId/enrollment/status Parameter

Request body

idempotencyKeystring

Optional retry key. Reuse with the identical payload after a timeout. Without a key, each submission creates a new request.

status'completed' | 'failed' | 'cancelled' required
reasonstring

Response

POST /v2/campaigns/:campaignId/enrollment/status Positive response

jobIdstring uuid required
statusUrlstring required
totalinteger required
resolvedCountinteger required

Changes

No recorded changes to this operation across all 2 revisions of this API.