Campaign Enrollment

Get campaign action results

Check the results of a campaign request you sent earlier. Requires campaign_enrollment.manage. Returns durable, organization- and campaign-scoped results in input order. duplicateOf references the first input that resolved to the same customer; its action runs only once. Counts include duplicate input positions. Poll every 2-5 seconds until completed, partial, or failed. An execution_uncertain result must be reviewed before issuing a new request.

get/v2/campaigns/{campaignId}/enrollment/requests/{jobId}

Request

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

Path parameters

campaignIdstring uuid required

GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Parameter

jobIdstring uuid required

GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Parameter

Response

GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Positive response

jobIdstring uuid required
campaignIdstring uuid required
action'enroll' | 'restart' | 'set_status' required
status'queued' | 'running' | 'completed' | 'partial' | 'failed' required
totalinteger required
processedinteger required
succeededinteger required
skippedinteger required
failedinteger required
completedAtstring nullable required

Changes

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