Campaigns

Pause campaign

Pauses a campaign; the only way to stop a scheduled campaign from firing. Resume undoes it, except within 5 minutes of the send time. Pausing a send already in progress also works, but only for accounts with the send-controls flag — for the rest the operation is 409. It is also 409 when the campaign cannot be paused in its current state, or is an Immediate one-time campaign that has not started sending, and 404 when the account has no campaign with the ID.

post/campaigns/{id}/pause

Request

  • Base URL
    https://api.textla.com/v1
  • Auth
    HTTP bearer

Path parameters

idstring required

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

batch_countinteger required
created_atinteger required
failure_codestring nullable required
idstring required
messagestring required
message_countinteger required
namestring required
phone_numberstring required
rejection_reasonstring nullable required
send_atinteger nullable required
statusstring required
updated_atinteger required

Example response

{
  "$schema": "/v1/schemas/Campaign.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.