Skip to main content
POST
Link 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 link_conversation_person.

participant_sid
string
required

The participant to link. It must belong to THIS thread, else 422 validation_failed on participant_sid.

Required string length: 18
Pattern: ^ub_pt_
person_sid
string
required

An EXISTING playtables person. Create the person with the playtables tools first; this verb never creates one.

Required string length: 18
Pattern: ^cr_pp_

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