POST/v1/comms/conversations/{id}/participants

Add somebody to a conversation

Puts a colleague (user_id) or an outside contact (external_contact_name with an email or a phone) on a thread's roster, with an optional role.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

idpath · stringrequired

Request body

application/jsonrequired

bodyoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "external_contact_email": "string",
  "external_contact_name": "string",
  "external_contact_phone": "string",
  "id": 1,
  "is_muted": true,
  "joined_at": "string",
  "left_at": "string",
  "participant_type": "string",
  "role": "string",
  "user_id": 1
}

external_contact_emailstringoptional

external_contact_namestringoptional

external_contact_phonestringoptional

idintegeroptional

is_mutedbooleanoptional

joined_atstringoptional

left_atstringoptional

participant_typestringoptional

rolestringoptional

user_idintegeroptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired