Skip to main content
POST
Approve message drafts

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.

Body

application/json

Request body of approve_messages.

sid
string | null

One draft to approve. Exactly one of sid | filter, else 422 invalid_input.

Required string length: 18
Pattern: ^ub_ms_
filter
object | null

Fan-out arm: approve every matching draft. The backend ANDs state=pending_approval in, so a filter of { conversation_sid: { eq } } clears one thread and {} clears the whole queue.

body
string | null

Inline edit of the text before it queues, min 1 char. SINGLE-SID MODE ONLY: sending it with filter is a 422.

Minimum string length: 1
subject
string | null

Inline edit of the email subject, max 998. Single-sid mode only.

Maximum string length: 998
scheduled_at
string | null

ISO 8601 UTC send time for this approval, overriding the draft's. Single-sid mode only.

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
object | null
required
result
object
required
meta
object
required