Skip to main content
PATCH
Change a scheduled message

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Path Parameters

id
string<uuid>
required

Public id of the conversation. A change needs one the member can see; a cancel does not.

scheduled_message_id
string<uuid>
required

Public id of one of the member's pending scheduled messages in this conversation.

Body

application/json
text
string
Required string length: 1 - 10000
Pattern: \S
scheduled_at
string<date-time>

An ISO 8601 timestamp with an explicit UTC offset (Z or +05:45); one without an offset is refused. Unlike a new schedule, it may be in the past.

theme
string | null
Maximum string length: 255
attachments
object[]

Files the client has uploaded, named by URL, as the legacy schedule endpoint takes them. They are added to the schedule's saved attachments; none can be removed. The URL is not checked as an owned upload.

Maximum array length: 10

Response

The scheduled message after the change.

One scheduled message.

status
integer
required
data
object
required

A message the member scheduled. When delivery claims it, it becomes an ordinary message of the conversation and is no longer listed here.

meta
object
required

Envelope metadata present on every response.