CampaignEnrollment
One Contact enrolled in a Campaign (1.65.0): its arm, status, disposition, attempts and Calls, identifiers and codes, and its variables only on include=content.
An object with 21 fields.
Fields
| 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. |
Used by
The operations whose parameters, request body or responses name this shape directly.