ConversationsParticipant

Update Conversation Participant

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

Update an existing participant in the conversation

Authorization

accountSid_authToken
AuthorizationBasic <token>

In: header

Path Parameters

ConversationSid*string

The unique ID of the Conversation for this participant.

Sid*string

A 34 character string that uniquely identifies this resource.

Header Parameters

X-Twilio-Webhook-Enabled?ConversationParticipantWebhookEnabledType

The X-Twilio-Webhook-Enabled HTTP request header

Value in

  • "true"
  • "false"

Request Body

application/x-www-form-urlencoded

DateCreated?string

The date that this resource was created.

Formatdate-time
DateUpdated?string

The date that this resource was last updated.

Formatdate-time
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.

RoleSid?string

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

Match^RL[0-9a-fA-F]{32}$
Length34 <= length <= 34
MessagingBinding.ProxyAddress?string

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

MessagingBinding.ProjectedAddress?string

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

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?|

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

LastReadTimestamp?string

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

Response Body

application/json

curl -X POST "https://example.com/v1/Conversations/string/Participants/string" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d 'Attributes=%7B+%22role%22%3A+%22driver%22+%7D&RoleSid=RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DateCreated=2015-12-16T22%3A18%3A37Z&DateUpdated=2015-12-16T22%3A18%3A38Z'

{  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "identity": null,  "attributes": "{ \"role\": \"driver\" }",  "messaging_binding": {    "type": "sms",    "address": "+15558675310",    "proxy_address": "+15017122661"  },  "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "date_created": "2015-12-16T22:18:37Z",  "date_updated": "2015-12-16T22:18:38Z",  "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "last_read_message_index": null,  "last_read_timestamp": null}