POST /v2/Services/{ServiceSid}/Users

TODO: Resource-level docs

Headers

  • X-Twilio-Webhook-Enabled string

    The X-Twilio-Webhook-Enabled HTTP request header

    Values are true or false.

Path parameters

  • ServiceSid string Required

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

application/x-www-form-urlencoded

Body

  • Attributes string
  • FriendlyName string
  • Identity string Required
  • RoleSid string

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

Responses

  • 201 application/json

    Created

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

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

    • attributes string | null
    • date_created string(date-time) | null
    • date_updated string(date-time) | null
    • friendly_name string | null
    • identity string | null
    • is_notifiable boolean | null
    • is_online boolean | null
    • joined_channels_count integer | null
    • role_sid string | null

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

    • service_sid string | null

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

    • sid string | null

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

    • url string(uri) | null
POST /v2/Services/{ServiceSid}/Users
curl \
 --request POST 'https://ip-messaging.twilio.com/v2/Services/{ServiceSid}/Users' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --header "X-Twilio-Webhook-Enabled: true" \
 --data 'Attributes=string&FriendlyName=string&Identity=string&RoleSid=string'
Response examples (201)
{
  "account_sid": "string",
  "attributes": "string",
  "date_created": "2026-05-04T09:42:00Z",
  "date_updated": "2026-05-04T09:42:00Z",
  "friendly_name": "string",
  "identity": "string",
  "is_notifiable": true,
  "is_online": true,
  "joined_channels_count": 42,
  "links": {},
  "role_sid": "string",
  "service_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}