Skip to content

Update user

Request

Update a user's attributes or their custom data. Changes will be merged into the user's profile, so you can specify only the fields you want to update.

Note:

  • Attributes (like name and address) cannot be partially updated, as the new value of an object or array will just replace the current one.
  • custom_data can be partially updated since it will be merged with the existing data (as a shallow merge).
.

Required permissions: apps:edit, [appId]:edit, users:edit.

Security
ClientAccessToken
Path
user_idstringrequired

The ID of the user that should be updated

Headers
user-agentstring
Bodyapplication/jsonrequired
emailstring

Primary email address of the user

phone_numberstring

Primary phone number of the user, specified in E.164 format

secondary_emailsArray of strings

Secondary email addresses to add to user's current emails

secondary_phone_numbersArray of strings

Secondary phone numbers to add to user's phone numbers, each specified in E.164 format

birthdaystring, (date-time)

User's birthday

addressobject

User's address

nameobject

Object describing user's full name

statusstring

Status of user

Enum:"Active""Disabled""Pending"
external_account_idstring

User identifier in an app, set by the app

custom_app_dataobject

Custom data object for app-related user info

picturestring

The picture of user, specified as a URL

languagestring

The language of the user, as provided by the browser using the Accept-Language header field

custom_dataobject

Custom data object for tenant user info

external_user_idstring

A unique identifier in a tenant

usernamestring

Username used to identify the user for password login (unless a primary email will be used instead)

custom_user_fieldsobject

Custom user fields defined by the tenant schema

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'user-agent: string' \
  -d '{
    "email": "string",
    "phone_number": "string",
    "secondary_emails": [
      "string"
    ],
    "secondary_phone_numbers": [
      "string"
    ],
    "birthday": "2019-08-24T14:15:22Z",
    "address": {
      "country": "string",
      "state": "string",
      "city": "string",
      "street_address": "string",
      "postal_code": "string",
      "type": "Home"
    },
    "name": {
      "title": "string",
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string"
    },
    "status": "Active",
    "external_account_id": "string",
    "custom_app_data": {},
    "picture": "string",
    "language": "string",
    "custom_data": {},
    "external_user_id": "string",
    "username": "string",
    "custom_user_fields": {}
  }'

Responses

Bodyapplication/json
resultobjectrequired
Response
{
  "result": {
    "email": { … },
    "secondary_emails": [ … ],
    "phone_number": { … },
    "secondary_phone_numbers": [ … ],
    "username": "string",
    "user_id": "string",
    "birthday": "2019-08-24T14:15:22Z",
    "address": { … },
    "name": { … },
    "status": "Active",
    "status_changed_at": "2019-08-24T14:15:22Z",
    "created_at": 0,
    "updated_at": 0,
    "identity_providers": [ … ],
    "identities": [ … ],
    "last_auth": "2019-08-24T14:15:22Z",
    "external_account_id": "string",
    "app_name": "string",
    "custom_app_data": {},
    "groupIds": [ … ],
    "picture": "string",
    "language": "string",
    "custom_data": {},
    "external_user_id": "string",
    "password_information": { … },
    "custom_user_fields": {}
  }
}