Sign in
ConversationsV2Participant

Update a Participant

Update an existing Participant

put/v2/Conversations/{ConversationId}/Participants/{id}

Request body

namestring
type'HUMAN_AGENT' | 'CUSTOMER' | 'AI_AGENT' | 'AGENT' | 'UNKNOWN'

Type of Participant in the Conversation.

profileIdstring

Example request

{
  "name": "Dana"
}

Response

OK

idstring required

Participant ID.

conversationIdstring required

Conversation ID.

accountIdstring required

Account ID.

namestring required

Participant display name.

type'HUMAN_AGENT' | 'CUSTOMER' | 'AI_AGENT' | 'AGENT' | 'UNKNOWN'

Type of Participant in the Conversation.

profileIdstring

Profile ID. Note: This field is only resolved for CUSTOMER participant types, not for HUMAN_AGENT or AI_AGENT participants.

createdAtstring date-time

Timestamp when this Participant was created.

updatedAtstring date-time

Timestamp when this Participant was last updated.

Example response

{
  "id": "conv_participant_00000000000000000000000001",
  "conversationId": "conv_conversation_00000000000000000000000001",
  "accountId": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "name": "Dana",
  "type": "CUSTOMER",
  "profileId": "mem_profile_00000000000000000000000000",
  "addresses": [
    {
      "channel": "SMS",
      "address": "+18005550100"
    },
    {
      "channel": "WHATSAPP",
      "address": "whatsapp:+18005550100"
    },
    {
      "channel": "RCS",
      "address": "rcs:+18005550100"
    }
  ],
  "createdAt": "2023-07-01T12:00:00Z",
  "updatedAt": "2023-07-01T12:30:00Z"
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.