POST
/conversations.joinJoin a conversation
Joins an existing conversation for the authenticated user. Supply the conversation identifier in channel and use an authentication token with the channels:write scope when authorization is required.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
tokenstringoptional
Authentication token for the request; it must provide the `channels:write` scope.
Optional form-encoded conversation details.
channelstringoptional
ID of conversation to join
200Returns a success object with `ok` set to true and the joined conversation in `channel`.
channelarrayrequired
okbooleanrequired
response_metadataobjectoptional
warningstringoptional
defaultTypical error response if the conversation is archived and cannot be joined
callstackstringoptional
Note: PHP callstack is only visible in dev/qa
errorstringrequired
neededstringoptional
okbooleanrequired
providedstringoptional
Error handling
channel must identify an existing conversation that the authenticated user can join. The token must provide the channels:write scope when supplied for authentication.