Sign in
ConversationsV1Participant

Add a new participant to the conversation

Add a new participant to the conversation

post/v1/Conversations/{ConversationSid}/Participants

Path parameters

ConversationSidstring required

The unique ID of the Conversation for this participant.

Headers

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

The X-Twilio-Webhook-Enabled HTTP request header

Response

Created

account_sidstring nullable

The unique ID of the Account responsible for this participant.

conversation_sidstring nullable

The unique ID of the Conversation for this participant.

sidstring nullable

A 34 character string that uniquely identifies this resource.

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.

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.

{"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.","extensionFields":{"x-twilio":{"pii":{"handling":"standard","deleteSla":30}}},"nullable":true}
role_sidstring nullable

The SID of a conversation-level Role to assign to the 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.

urlstring uri nullable

An absolute API resource URL for this participant.

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.

Changes

Changed in 3 of the 51 revisions of this API.21

  • v192d1169c37c21See the full diff
    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

  • v1b4d0e634cd691See the full diff
    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

  • v14e3f150aaa781See the full diff
    • ○

      api tag ConversationsV1Participant added

      api-tag-added