Restart customers in a campaign
Send customers back to the first step of a campaign they are already in. 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. They start over from the beginning of the currently published workflow. Customers who are not in the campaign are skipped.
Request
- Base URLhttps://api.carecycle.ai
- URLhttps://api.carecycle.ai/v2/campaigns/{campaignId}/enrollment/restart
- AuthAPI key in header x-api-key
Path parameters
POST /v2/campaigns/:campaignId/enrollment/restart Parameter
Request body
Response
POST /v2/campaigns/:campaignId/enrollment/restart Positive response
Changes
No recorded changes to this operation across all 2 revisions of this API.