CampaignCreateRequest
Creates a draft Campaign at revision 1 (1.65.0), with an Idempotency-Key. Omitted blocks take their defaults: three attempts, last_attempt voicemail, customer_attested consent; the budget is required only at launch. Every issue is a detail of 422 validation_failed (CampaignIssueCode).
An object with 16 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
arms | array of CampaignArmInput | yes | |
budget | CampaignBudgetInput | no | |
consent | CampaignConsentInput | no | |
contact_caps | CampaignContactCapsInput | no | |
identity | CampaignIdentityInput | yes | |
name | string | yes | A label, never PHI (product terms): no patient, condition or appointment. |
numbers | CampaignNumbersInput | yes | |
on_exhausted | CampaignOnExhaustedInput | no | |
outcome_routing | CampaignOutcomeRoutingInput | no | |
pacing | CampaignPacingInput | yes | |
purpose | CampaignPurpose | yes | |
retry | CampaignRetryInput | no | |
schedule | CampaignScheduleInput | yes | |
transport | CampaignTransport | yes | |
voicemail | CampaignVoicemailInput | no | |
windows | CampaignWindowInput | yes |
Used by
The operations whose parameters, request body or responses name this shape directly.