Create a campaign
POST/api/v1/campaigns
Creates a campaign in draft — or in scheduled when scheduledAt is in the future. Creating does not place any call: use the start endpoint, or let the scheduler pick up a scheduled campaign.
The audio must already exist. Upload one, or synthesise one from a text, then pass its fsUrl as audioFile. A campaign never holds a text waiting to be synthesised.
When contactGroupId is given, the group is expanded into the campaign right away, so the contact list is visible before the campaign is started.
Required capability: CAMPAIGNS
Request
Responses
- 201
- 400
- 401
- 403
- 429
The campaign has been created.
Invalid payload, or a scheduled campaign whose contact group is empty.
Missing or invalid API key.
A capability required by this endpoint is not enabled on your account. Ask your account manager to switch it on.
Too many requests. Back off and retry.