Campaigns

Cancel campaign

Stops a send that is in progress; the campaign cannot be resumed afterward. It is 409 when the campaign has no send in progress or is not active or paused, and 409 when the campaign is still sending and the account does not have send controls enabled. It is 404 when the account has no campaign with the ID.

post/campaigns/{id}/cancel

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.