scheduledMessages

Cancel messages

Changed on

Cancel messages by ID or by contact. A cancelled message leaves the line and is never sent.

patch/scheduled-messages/cancel

Request

  • Base URL: https://api.bereach.ai
  • URL: https://api.bereach.ai/scheduled-messages/cancel
  • Auth: HTTP bearer

Request body

messageIdsstring[]

Cancel specific messages

contactIdsstring[]

Cancel everything still waiting for these contacts, within the list named by campaignId, which contactIds needs. Prefer messageIds, read from the outbox

campaignIdstring

The list to cancel within

Response

Messages cancelled

successtrue required
cancelledinteger required
notFoundstring[]

Named message ids that match nothing.

creditsUsedinteger required

Credits this call spent, net of anything given back. 0 when nothing was charged: a free read, a cached answer, nothing delivered.

retryAfterinteger required

Seconds to wait before another call of the same type. 0 means no wait is needed.

Changes