Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1410161228.2 KB

Update a specific User Conversation.

post/v1/Users/{UserSid}/Conversations/{ConversationSid}

Path parameters

UserSidstring required

The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.

ConversationSidstring required

The unique SID identifier of the Conversation. This value can be either the sid or the unique_name of the Conversation resource.

Response

OK

account_sidstring nullable

The unique ID of the Account responsible for this conversation.

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.

chat_service_sidstring nullable

The unique ID of the Conversation Service this conversation belongs to.

conversation_sidstring nullable

The unique ID of the Conversation for this User Conversation.

conversation_state'inactive' | 'active' | 'closed'
created_bystring nullable

Identity of the creator of this Conversation.

date_createdstring date-time nullable

The date that this conversation was created, given in ISO 8601 format.

date_updatedstring date-time nullable

The date that this conversation was last updated, given in ISO 8601 format.

friendly_namestring nullable

The human-readable name of this conversation, limited to 256 characters. Optional.

last_read_message_indexinteger nullable

The index of the last Message in the Conversation that the Participant has read.

linksobject nullable

Contains absolute URLs to access the participant and conversation of this conversation.

notification_level'default' | 'muted'
participant_sidstring nullable

The unique ID of the participant the user conversation belongs to.

{"stackTrail":"components:schemas:conversations.v1.user.user_conversation:properties:timers","oasType":"schema","type":"unknown","description":"Timer date values representing state update for this conversation.","nullable":true}
unique_namestring nullable

An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's conversation_sid in the URL.

unread_messages_countinteger nullable

The number of unread Messages in the Conversation for the Participant.

urlstring uri nullable
user_sidstring nullable

The unique string that identifies the User resource.