Add a new participant to the conversation in a specific service

POST /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants

A Service Participant resource represents a member of the conversation within a specific service.

Add a new participant to the conversation in a specific service

Headers

Path parameters

Body

  • Attributes string

    An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.

  • DateCreated string(date-time)

    The date that this resource was created.

  • DateUpdated string(date-time)

    The date that this resource was last updated.

  • Identity string

    A unique string identifier for the conversation participant as Conversation User. This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters.

  • MessagingBinding.Address string

    The address of the participant's device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with proxy_address) is only null when the participant is interacting from an SDK endpoint (see the 'identity' field).

  • MessagingBinding.ProjectedAddress string

    The address of the Twilio phone number that is used in Group MMS. Communication mask for the Conversation participant with Identity.

  • MessagingBinding.ProxyAddress string

    The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the 'identity' field).

  • RoleSid string

    The SID of a conversation-level Role to assign to the participant.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The unique ID of the Account responsible for this participant.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • attributes string | null

      An optional string metadata field you can use to store any data you wish.

    • chat_service_sid string | null

      The SID of the Conversation Service that the resource is associated with.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

    • conversation_sid string | null

      The unique ID of the Conversation for this participant.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

      The date that this resource was created.

    • date_updated string(date-time) | null

      The date that this resource was last updated.

    • identity string | null

      A unique string identifier for the conversation participant as Conversation User.

    • last_read_message_index integer | null

      Index of last “read” message in the Conversation for the Participant.

    • last_read_timestamp string | null

      Timestamp of last “read” message in the Conversation for the Participant.

    • messaging_binding

      Information about how this participant exchanges messages with the conversation.

    • role_sid string | null

      The SID of a conversation-level Role to assign to the participant

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.

    • sid string | null

      A 34 character string that uniquely identifies this resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MB[0-9a-fA-F]{32}$.

    • url string(uri) | null

      An absolute URL for this participant.
POST /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants 
curl \
 -X POST https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -H "X-Twilio-Webhook-Enabled: true" \
 -d 'Attributes=string&DateCreated=2023-05-04T09%3A42%3A00%2B00%3A00&DateUpdated=2023-05-04T09%3A42%3A00%2B00%3A00&Identity=string&MessagingBinding.Address=string&MessagingBinding.ProjectedAddress=string&MessagingBinding.ProxyAddress=string&RoleSid=string'
Request example 
# Headers
X-Twilio-Webhook-Enabled: true

# Payload
{
  "Attributes": "string",
  "DateCreated": "2023-05-04T09:42:00+00:00",
  "DateUpdated": "2023-05-04T09:42:00+00:00",
  "Identity": "string",
  "MessagingBinding.Address": "string",
  "MessagingBinding.ProjectedAddress": "string",
  "MessagingBinding.ProxyAddress": "string",
  "RoleSid": "string"
}
Request examples 
# Headers
X-Twilio-Webhook-Enabled: true

# Payload
{
  "Attributes": "string",
  "DateCreated": "2024-05-04T09:42:00+00:00",
  "DateUpdated": "2024-05-04T09:42:00+00:00",
  "Identity": "string",
  "MessagingBinding.Address": "string",
  "MessagingBinding.ProjectedAddress": "string",
  "MessagingBinding.ProxyAddress": "string",
  "RoleSid": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "attributes": "string",
  "chat_service_sid": "string",
  "conversation_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "identity": "string",
  "last_read_message_index": 42,
  "last_read_timestamp": "string",
  "role_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "attributes": "string",
  "chat_service_sid": "string",
  "conversation_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "identity": "string",
  "last_read_message_index": 42,
  "last_read_timestamp": "string",
  "role_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}