Create a campaign
create_campaignCreate a draft outbound campaign: agent, caller-id numbers, contact list, purpose, consent_basis (existing_customer | explicit_consent), calling windows, retry policy (or a preset: sales, collections, single_attempt), concurrency and optional schedule. It starts only when launched with launch_campaign.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| ends_at | No | ||
| purpose | Yes | Required, free-form outbound purpose declaration -- never refused for being novel. Any non-empty token is accepted; the documented advisory catalog is: appointment, booking_confirmation, callback_requested, customer_outreach, delivery_notification, ops_alert, other, payment_reminder, personal_errand, reservation, status_check, support. | |
| agent_id | Yes | ||
| language | No | ||
| time_zone | No | IANA time zone (default UTC), matched and stored like a contact's time_zone: ignoring case, another spelling of a zone stored as the zone it names, an offset such as UTC-5 refused. | |
| project_id | Yes | ||
| retry_policy | No | ||
| consent_basis | Yes | ||
| time_zone_mode | No | ||
| calling_windows | No | {weekday: [{start: 'HH:MM', end: 'HH:MM'}]}; defaults per destination country. | |
| contact_list_id | Yes | ||
| from_number_ids | Yes | ||
| max_concurrency | No | ||
| organization_id | No | Optional. Defaults to the authenticated workspace; when supplied it must be that workspace's id. | |
| scheduled_start_at | No | ||
| retry_policy_preset | No | ||
| reserved_concurrency | No |