scheduledMessages

Edit a draft DM

Changed on

Edit the text of a draft DM, in line or not. Only rows in draft status are editable: sending, sent, failed and cancelled rows are not. Returns {updated, ineligible} so the caller can distinguish missing ids from rows that cannot be edited.

patch/scheduled-messages/update

Request

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

Request body

messageIdstring required

Scheduled message id to edit

messagestring

New DM text

scheduledSendAtstring nullable

Accepted and ignored: a first message has no send time.

Response

Message updated

successtrue required
updatedinteger required

How many rows were edited.

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