Campaign

A Campaign (1.65.0, ADR 0050): its status, its configuration with every default explicit, the revision in force, the attestation and its spend. Counts are in CampaignProgress; enrollments in CampaignEnrollment.

An object with 34 fields.

Fields

Field	Type	Required	Description
`archived`	boolean	yes	True once `DELETE` archived an ended Campaign.
`arms`	array of CampaignArm	yes
`attestation`	CampaignAttestation or null	yes
`budget`	CampaignBudget or null	yes	Required at launch.
`consent`	CampaignConsent	yes
`contact_caps`	CampaignContactCaps or null	yes
`created_at`	Timestamp	yes
`current_revision`	integer or null	yes	The frozen revision in force; null before launch.
`ended_at`	Timestamp or null	yes
`environment`	Environment	yes
`error_code`	string or null	yes	Why a `failed` Campaign failed; null otherwise.
`id`	CampaignId	yes
`identity`	CampaignIdentity	yes
`launched_at`	Timestamp or null	yes
`name`	string	yes	A label, never PHI (product terms): no patient, condition or appointment.
`numbers`	CampaignNumbers	yes
`object`	`"campaign"`	yes
`on_exhausted`	CampaignOnExhausted or null	yes
`organization_id`	OrganizationId	yes
`outcome_routing`	CampaignOutcomeRouting or null	yes
`pacing`	CampaignPacing	yes
`paused_reason`	CampaignPausedReason or null	yes	Why it is `paused`; null otherwise.
`project_id`	ProjectId or null	yes
`purpose`	CampaignPurpose	yes
`retry`	CampaignRetry	yes
`revision`	integer	yes	The draft's revision, the ETag If-Match names.
`schedule`	CampaignSchedule	yes
`spend_micros`	integer	yes	The rated charges of the Campaign's Calls so far.
`status`	CampaignStatus	yes
`supervisor_process_id`	ProcessInstanceId or null	yes	The supervisor Process instance; null before launch.
`transport`	CampaignTransport	yes
`updated_at`	Timestamp	yes
`voicemail`	CampaignVoicemail	yes
`windows`	CampaignWindow	yes

Used by

The operations whose parameters, request body or responses name this shape directly.