Conversations Participants | API

Ensure the conversation has a specific participant

Add a participant to the conversation

POST/workspaces/{workspaceId}/conversations/{conversationId}/participants

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationId*any of

The conversation ID

Body

nullable Conversations_CreateParticipant (object)

Response

Participant already exists

Body

id*string

displayNamestring

avatarUrlstring

contactConversationParticipantContact

type*Conversations_ParticipantType (enum)

usercontactflowbotaccessKeychannelconnectorcollaborationAutomation

statusenum

pendinginvitedactive

Request

const response = await fetch('/workspaces/{workspaceId}/conversations/{conversationId}/participants', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "type": "user",
      "status": "pending"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "displayName": "text",
  "avatarUrl": "text",
  "contact": {
    "identifierKey": "text",
    "identifierValue": "text",
    "platformAddress": "text",
    "platformAddressSelector": "text"
  },
  "type": "user",
  "status": "pending"
}

List conversation participants

Retrieve the participants to a conversation

GET/workspaces/{workspaceId}/conversations/{conversationId}/participants

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationId*any of

The conversation ID

Query parameters

Response

A list of participants is returned

Body

results*array of ConversationParticipant

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

const response = await fetch('/workspaces/{workspaceId}/conversations/{conversationId}/participants', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "results": [
    {
      "id": "text",
      "displayName": "text",
      "avatarUrl": "text",
      "contact": {
        "identifierKey": "text",
        "identifierValue": "text",
        "platformAddress": "text",
        "platformAddressSelector": "text"
      },
      "type": "user",
      "status": "pending"
    }
  ],
  "nextPageToken": "text"
}

Ensure the conversation has a specific participant

Add a participant to the conversation

POST/workspaces/{workspaceId}/conversations/{conversationId}/participants

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationId*any of

The conversation ID

Body

nullable Conversations_CreateParticipant (object)

Response

Participant already exists

Body

id*string

displayNamestring

avatarUrlstring

contactConversationParticipantContact

type*Conversations_ParticipantType (enum)

usercontactflowbotaccessKeychannelconnectorcollaborationAutomation

statusenum

pendinginvitedactive

Request

const response = await fetch('/workspaces/{workspaceId}/conversations/{conversationId}/participants', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "type": "user",
      "status": "pending"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "displayName": "text",
  "avatarUrl": "text",
  "contact": {
    "identifierKey": "text",
    "identifierValue": "text",
    "platformAddress": "text",
    "platformAddressSelector": "text"
  },
  "type": "user",
  "status": "pending"
}

PARAMETERS/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationId*any of

The conversation ID

conversationParticipantId*string

The ID that refers to the conversation participant (e.g. the contact ID if the participant is a contact)

Request

const response = await fetch('/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}', {
    method: 'PARAMETERS',
    headers: {},
});
const data = await response.json();

Update conversation participant

Update a participant's status in the conversation

PATCH/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationId*any of

The conversation ID

conversationParticipantId*string

The ID that refers to the conversation participant (e.g. the contact ID if the participant is a contact)

Body

statusnullable enum

pendinginvitedactive

Response

Participant was updated

Body

id*string

displayNamestring

avatarUrlstring

contactConversationParticipantContact

type*Conversations_ParticipantType (enum)

usercontactflowbotaccessKeychannelconnectorcollaborationAutomation

statusenum

pendinginvitedactive

Request

const response = await fetch('/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "displayName": "text",
  "avatarUrl": "text",
  "contact": {
    "identifierKey": "text",
    "identifierValue": "text",
    "platformAddress": "text",
    "platformAddressSelector": "text"
  },
  "type": "user",
  "status": "pending"
}

Delete conversation participant

Removes a participant from the conversation

DELETE/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationId*any of

The conversation ID

conversationParticipantId*string

The ID that refers to the conversation participant (e.g. the contact ID if the participant is a contact)

Response

Participant was removed

Request

const response = await fetch('/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "code": "ResourceNotFound",
  "message": "The requested resource does not exist"
}

PARAMETERS/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantIdentifierKey}/{conversationParticipantIdentifierValue}

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationId*any of

The conversation ID

conversationParticipantIdentifierKey*string

The key that refers to the conversation participant identifier

conversationParticipantIdentifierValue*string

The value that refers to the conversation participant identifier

Request

const response = await fetch('/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantIdentifierKey}/{conversationParticipantIdentifierValue}', {
    method: 'PARAMETERS',
    headers: {},
});
const data = await response.json();

Update conversation participant by contact

Update a participant's status in the conversation by contact

PATCH/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantIdentifierKey}/{conversationParticipantIdentifierValue}

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationId*any of

The conversation ID

conversationParticipantIdentifierKey*string

The key that refers to the conversation participant identifier

conversationParticipantIdentifierValue*string

The value that refers to the conversation participant identifier

Body

statusnullable enum

pendinginvitedactive

Response

Participant was updated

Body

id*string

displayNamestring

avatarUrlstring

contactConversationParticipantContact

type*Conversations_ParticipantType (enum)

usercontactflowbotaccessKeychannelconnectorcollaborationAutomation

statusenum

pendinginvitedactive

Request

const response = await fetch('/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantIdentifierKey}/{conversationParticipantIdentifierValue}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "displayName": "text",
  "avatarUrl": "text",
  "contact": {
    "identifierKey": "text",
    "identifierValue": "text",
    "platformAddress": "text",
    "platformAddressSelector": "text"
  },
  "type": "user",
  "status": "pending"
}