Update an existing participant in the conversation

POST /v1/Conversations/{ConversationSid}/Participants/{Sid}

A Participant resource represents a member of the conversation.

Update an existing participant in the conversation

Headers

Path parameters

  • ConversationSid string Required

    The unique ID of the Conversation for this participant.

  • Sid string Required

    A 34 character string that uniquely identifies this resource.

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 Conversations SDK to communicate. Limited to 256 characters.

  • LastReadMessageIndex integer | null

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

  • LastReadTimestamp string

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

  • MessagingBinding.ProjectedAddress string

    The address of the Twilio phone number that is used in Group MMS. 'null' value will remove it.

  • MessagingBinding.ProxyAddress string

    The address of the Twilio phone number that the participant is in contact with. 'null' value will remove it.

  • 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

  • 200

    OK

    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.

    • 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/Conversations/{ConversationSid}/Participants/{Sid} 
curl \
 -X POST https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Participants/{Sid} \
 --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&LastReadMessageIndex=42&LastReadTimestamp=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",
  "LastReadMessageIndex": 42,
  "LastReadTimestamp": "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",
  "LastReadMessageIndex": 42,
  "LastReadTimestamp": "string",
  "MessagingBinding.ProjectedAddress": "string",
  "MessagingBinding.ProxyAddress": "string",
  "RoleSid": "string"
}
Response examples (200) 
{
  "account_sid": "string",
  "attributes": "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 (200) 
{
  "account_sid": "string",
  "attributes": "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"
}