Create user

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

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

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
- links object(uri-map) | 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 \
 -X POST https://ip-messaging.twilio.com/v2/Services/{ServiceSid}/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",
  "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,
  "joined_channels_count": 42,
  "links": {},
  "role_sid": "string",
  "service_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}

Response examples (201)

{
  "account_sid": "string",
  "attributes": "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,
  "joined_channels_count": 42,
  "links": {},
  "role_sid": "string",
  "service_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}