Skip to main content
PATCH
Update message draft

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

The draft to edit. Any state but pending_approval answers 409 message_not_editable.

Required string length: 18
Pattern: ^ub_ms_

Body

application/json

Request body of update_message.

subject
string | null

Email subject line, max 998; null clears it. Ignored on LinkedIn rows.

Maximum string length: 998
body_text
string

Full replacement of the draft text, min 1 char, plain text. NOTE the key: the write side is body_text here, while send_message takes body.

Minimum string length: 1
scheduled_at
string | null

ISO 8601 UTC hold time for the send; null = dispatch as soon as approved. Applied when the draft is approved.

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.