Skip to main content
PATCH
Edit a queued message

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Path Parameters

sendId
string
required

The queued message's id, from GET /v1/campaigns/{campaignId}/queue.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$

Body

application/json
subject
string

A new subject line, up to 500 characters.

Maximum string length: 500
body
string

A new message, up to 20,000 characters, sent as written: tokens such as {Contact First Name} are filled in when a step's message is written, not in an edit.

Maximum string length: 20000
scheduledAt
string

When to send it instead, as an ISO 8601 date-time in UTC.

Response

The new message that replaces the one named.

id
string
required

The new message.

replacedSendId
string
required

The message named, now overwritten.

status
string
subject
string
scheduledAt
string<date-time>