Skip to main content
All campaign endpoints require an API key with the appropriate scope. Campaigns are scoped to the tenant bound to your API key.

Create a campaign

Request body

Scope: campaigns:write  |  Status: 201 Created

Response

Returns a CampaignResponse object with id, name, dial_mode, status ("draft"), timestamps, and all configured fields.

List campaigns

Returns all campaigns for the tenant bound to your API key.
Scope: campaigns:read  |  Status: 200 OK

Get a campaign

Scope: campaigns:read  |  Status: 200 OK Returns 404 if the campaign does not exist or belongs to a different tenant.

Update a campaign

PATCH semantics — only include the fields you want to change.
Scope: campaigns:write  |  Status: 200 OK

Delete a campaign

Scope: campaigns:write  |  Status: 204 No Content Returns 409 Conflict if the campaign is in a state that cannot be deleted (e.g., currently running).

Errors