pending-sends-v2

Withdraw a pending or approved send before it is executed

delete/v2/pending-sends/{pending_id}

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/pending-sends/{pending_id}
  • Auth: API key in header X-Api-Key

Response

Cancelled

api_key_idstring

ID of the key that submitted it

created_atstring

ISO8601 UTC

decided_atstring nullable

When it was approved, rejected, or cancelled (ISO8601 UTC)

decided_bystring nullable

user:<id> for a dashboard decision, api_key:<id> for a cancel

decision_reasonstring nullable

Rejection reason given by the approver

executed_atstring nullable

When the approved payload was sent (ISO8601 UTC)

executed_by_key_idstring nullable

ID of the key that executed it

executionobject nullable

Durable publication evidence; uncertain outcomes must be reconciled

expires_atstring

When an undecided or unexecuted send lapses (ISO8601 UTC); 24 hours after creation

idstring

Pending send ID

kindstring

send | send_bulk

last_errorobject nullable

The send error body from the most recent failed execute attempt; null otherwise

notestring nullable

The note as submitted

payloadobject

The held payload exactly as submitted: a send body, or {messages: [...]}

recipient_countinteger

Messages in the held payload

resultobject nullable

The send response body once executed; null before

sandboxboolean

True when held by a sandbox key; only a key in the same mode can execute it

statusstring

pending | approved | executing | unknown_execution | sent | rejected | cancelled | expired

Changes

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