Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1410161228.2 KB

Update an existing participant in the conversation

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

Path parameters

ConversationSidstring required

The unique ID of the Conversation for this participant.

Sidstring required

A 34 character string that uniquely identifies this resource.

Headers

X-Twilio-Webhook-Enabled'true' | 'false'

The X-Twilio-Webhook-Enabled HTTP request header

Response

OK

account_sidstring nullable

The unique ID of the Account responsible for this participant.

attributesstring nullable

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.

conversation_sidstring nullable

The unique ID of the Conversation for this participant.

date_createdstring date-time nullable

The date that this resource was created.

date_updatedstring date-time nullable

The date that this resource was last updated.

identitystring nullable

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.

last_read_message_indexinteger nullable

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

last_read_timestampstring nullable

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

{"stackTrail":"components:schemas:conversations.v1.conversation.conversation_participant:properties:messaging_binding","oasType":"schema","type":"unknown","description":"Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.","nullable":true}
role_sidstring nullable

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

sidstring nullable

A 34 character string that uniquely identifies this resource.

urlstring uri nullable

An absolute API resource URL for this participant.