Skip to main content
POST
Dismiss 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 dismiss_messages.

sid
string | null

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

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

Fan-out arm: reject every matching draft (the backend ANDs state=pending_approval in).

reason
string | null

Why it was rejected, max 255. Stored for the learning loop; it is not sent anywhere and not shown to the counterpart.

Maximum string length: 255

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