Sign in

v2

latestOpenAPI 3.0.3AGPL-3.0 license2026-07-2613501.9 MB
contacts

Campaign state transition

Transition a campaign between states: activate, start, pause, resume, complete, reset..

post/contacts/campaigns/{campaignId}/status

Path parameters

campaignIdstring required

Campaign ID

Request body

action'play' | 'pause' | 'complete' | 'reset' required
scheduledStartTimestring
scheduledStopTimestring
timezonestring
runDaysstring[]

Days the campaign runs user-action tasks. Use lowercase day names (e.g. monday, tuesday); pick at least one.

dailyActionLimitinteger

Response

Status updated

successtrue required
creditsUsedinteger required

Credits consumed by this call (always 0 for contacts queries).

retryAfterinteger required

Seconds to wait before next call of the same type (always 0 for contacts queries).