Skip to main content
POST
Resume Campaign

Authorizations

X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy. A key carries up to three permissions: public:read for GET requests, public:write for POST, PATCH, and PUT requests, and public:delete for DELETE requests. public:delete is only available together with public:write.

Headers

Idempotency-Key
string

Optional idempotency key: a unique string of 16-200 printable ASCII characters (a UUID is recommended). Retrying the write with the same key within 24 hours returns the stored response of the first call with an X-Idempotent-Replayed: true response header instead of executing it again. Reusing a key with a different request body returns 422 (IDEMPOTENCY_MISMATCH); a duplicate sent while the first call is still running returns 409 with a Retry-After header. Keys are scoped per endpoint and organization.

Required string length: 16 - 200

Path Parameters

id
string
required

Resource ID

Body

application/json
resume_at
string<date-time> | null

When to resume, as an ISO 8601 date-time with Z or an offset. Omit or send null to resume now. More than a minute ahead plans the resume and the campaign stays paused until then; more than a minute in the past returns 400 VALIDATION_ERROR.

Response

Campaign resumed, resume planned (still paused with resume_at set), or already running (current state returned).

success
boolean
required
data
object
required