Update flex user for the given flex user sid

POST /v2/Instances/{InstanceSid}/Users/{FlexUserSid}
Account sid auth token

Update flex user for the given flex user sid

Path parameters

  • InstanceSid string Required

    The unique ID created by Twilio to identify a Flex instance.

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

  • FlexUserSid string Required

    The unique id for the flex user.

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

application/x-www-form-urlencoded

Body

  • Email string

    Email of the User.

  • UserSid string

    The unique SID identifier of the Twilio Unified User.

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

  • Locale string

    The locale preference of the user.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

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

      The unique 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}$.

    • instance_sid string | null

      The unique ID created by Twilio to identify a Flex instance.

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

    • user_sid string | null

      The unique SID identifier of the Twilio Unified User.

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

    • flex_user_sid string | null

      The unique SID identifier of the Flex User.

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

    • worker_sid string | null

      The unique SID identifier of the worker.

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

    • workspace_sid string | null

      The unique SID identifier of the workspace.

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

    • flex_team_sid string | null

      The unique SID identifier of the Flex Team.

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

    • username string | null

      Username of the User.

    • email string | null

      Email of the User.

    • locale string | null

      The locale preference of the user.

    • roles array[string] | null

      The roles of the user.

    • created_date string(date-time) | null

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

    • updated_date string(date-time) | null

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

    • version integer

      The current version of the user.

      Default value is 0.

    • url string(uri) | null
POST /v2/Instances/{InstanceSid}/Users/{FlexUserSid} 
curl \
 --request POST 'https://flex-api.twilio.com/v2/Instances/{InstanceSid}/Users/{FlexUserSid}' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Email=sample%40example.com'
Request example 
{"Email"=>"sample@example.com"}
Response examples (200) 
{
  "url": "https://flex-api.twilio.com/v2/Instances/GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/FUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "email": "sample@example.com",
  "roles": [
    "agent"
  ],
  "locale": "en-US",
  "version": 1,
  "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "username": "username",
  "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "created_date": "2024-07-31T04:00:00Z",
  "instance_sid": "GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "updated_date": "2024-07-31T04:00:00Z",
  "flex_team_sid": "QOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "flex_user_sid": "FUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}