Skip to main content
POST
Unlink conversation person

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

Conversation sid (ub_cv_...).

Required string length: 18
Pattern: ^ub_cv_

Body

application/json

Request body of unlink_conversation_person.

participant_sid
string
required

The participant to detach. It must belong to THIS thread (422) and must currently carry a link (409 participant_not_linked).

Required string length: 18
Pattern: ^ub_pt_

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