careCycle
Campaign Enrollment

Get campaign action results

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}

Authorization

x-api-key
x-api-key<token>

API key required for authentication.

Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.

In: header

Path Parameters

string

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

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Formatuuid
string

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

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.carecycle.ai/v2/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/enrollment/requests/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",
  "action": "enroll",
  "status": "queued",
  "total": -9007199254740991,
  "processed": -9007199254740991,
  "succeeded": -9007199254740991,
  "skipped": -9007199254740991,
  "failed": -9007199254740991,
  "completedAt": "string",
  "items": [
    {
      "index": 9007199254740991,
      "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
      "duplicateOf": 9007199254740991,
      "validationErrors": [
        {
          "field": "customerId",
          "message": "string"
        }
      ],
      "outcome": "pending",
      "code": "enrolled",
      "customerCampaignId": "36ca8d1d-3d3d-48cf-bd1f-a796d8849d75"
    }
  ]
}
{
  "message": "string",
  "code": "string"
}
{
  "message": "string",
  "code": "string"
}
{
  "message": "string",
  "code": "string"
}
{
  "message": "string",
  "code": "string"
}
{
  "message": "string",
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "path": [
        "string"
      ],
      "message": "string",
      "expected": "string",
      "received": "string",
      "code": "string"
    }
  ],
  "failedRecords": [
    {
      "index": 0,
      "phoneNumber": "string",
      "firstName": "string",
      "lastName": "string",
      "externalId": "string"
    }
  ]
}
{
  "message": "string",
  "code": "string",
  "retryAfter": 0
}
{
  "message": "string",
  "code": "string"
}
{
  "message": "string",
  "code": "string"
}
{
  "message": "string",
  "code": "string"
}