scheduledMessages

Put drafts in line to be sent

Changed on

Put written drafts in line to be sent. The line decides when: each message goes out once the person is connected on this account. A message that could not be sent re-enters the line the same way. No time can be chosen.

post/scheduled-messages/schedule

Request

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

Request body

contactIdsstring[]

Put every draft of these contacts in line, within ONE list: campaignId or campaignSlug is required with this, or the call is refused. Prefer messageIds, read from the outbox

messageIdsstring[]

Put these messages in line

sendNowboolean

Move these to the front of the line. They still wait for the person to be connected.

scheduledSendAtstring

A time within 10 minutes of now is read the same as sendNow; anything later is ignored.

editedMessagesobject

Map of messageId to new content for last-minute edits before approving

Response

Messages put in line

successtrue required
scheduledinteger required

Total now in line: messages (queued, put back, or already there) plus connection requests among them, counted in invitationsScheduled below.

invitationsScheduledinteger

Connection requests among the ids, handed to the invitation line.

queuedinteger required

Messages that entered the line.

requeuedinteger required

Messages that could not be sent before and are back in line.

alreadyQueuedinteger required

Messages that were already in line.

bumpedinteger

Among alreadyQueued, messages moved to the front.

heldinteger required

Messages held for a read; release the hold first.

invitesQueuedinteger required

Invitations put in line for people not connected yet.

accountsstring[] required

The connected accounts whose lines gained a message.

notestring

Present when a send time was passed: it was ignored, and this says why.

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