Add a new conversation user to your service

POST /v1/Services/{ChatServiceSid}/Users

A Service User resource represents a conversation user belonging to a specific conversation service.

Add a new conversation user to your service

Headers

Path parameters

Body

  • Attributes string

    The JSON Object string that stores application-specific data. If attributes have not been set, {} is returned.

  • FriendlyName string

    The string that you assigned to describe the resource.

  • Identity string Required

    The application-defined string that uniquely identifies the resource's User within the Conversation Service. This value is often a username or an email address, and is case-sensitive.

  • RoleSid string

    The SID of a service-level Role to assign to the user.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • attributes string | null

      The JSON Object string that stores application-specific data

    • chat_service_sid string | null

      The SID of the Conversation Service that the resource is associated with

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • friendly_name string | null

      The string that you assigned to describe the resource

    • identity string | null

      The string that identifies the resource's User

    • is_notifiable boolean | null

      Whether the User has a potentially valid Push Notification registration for this Conversations Service

    • is_online boolean | null

      Whether the User is actively connected to this Conversations Service and online

    • links object(uri-map) | null
    • role_sid string | null

      The SID of a service-level Role assigned to the user

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^US[0-9a-fA-F]{32}$.

    • url string(uri) | null

      An absolute URL for this user.
POST /v1/Services/{ChatServiceSid}/Users 
curl \
 -X POST https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Users \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -H "X-Twilio-Webhook-Enabled: true" \
 -d 'Attributes=string&FriendlyName=string&Identity=string&RoleSid=string'
Request example 
# Headers
X-Twilio-Webhook-Enabled: true

# Payload
{
  "Attributes": "string",
  "FriendlyName": "string",
  "Identity": "string",
  "RoleSid": "string"
}
Request examples 
# Headers
X-Twilio-Webhook-Enabled: true

# Payload
{
  "Attributes": "string",
  "FriendlyName": "string",
  "Identity": "string",
  "RoleSid": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "attributes": "string",
  "chat_service_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "identity": "string",
  "is_notifiable": true,
  "is_online": true,
  "links": {},
  "role_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "attributes": "string",
  "chat_service_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "identity": "string",
  "is_notifiable": true,
  "is_online": true,
  "links": {},
  "role_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}