Sign in

v21

latestOpenAPI 3.1.0MIT Licenseraw.githubusercontent.com2026-08-0317123232.1 KB
Users

Create a User

Create a User

post/platform/api/v1/users

Request body

namestring

Name of the user

display_namestring

Display name of the user

emailstring

Email of the user

passwordstring

Password must contain uppercase, lowercase letters, number and a special character

custom_attributesobject

Custom attributes you want to associate with the user

Example request

{
  "name": "Daniel",
  "display_name": "Dan",
  "email": "daniel@acme.inc",
  "password": "Password2!",
  "custom_attributes": {}
}

Response

Success

idnumber
access_tokenstring
account_idnumber
available_namestring
avatar_urlstring
confirmedboolean
display_namestring nullable
message_signaturestring nullable
emailstring
hmac_identifierstring
inviter_idnumber nullable
namestring
providerstring
pubsub_tokenstring
role'agent' | 'administrator'
ui_settingsobject
uidstring
typestring nullable
custom_attributesobject

Available for users who are created through platform APIs and has custom attributes associated.