Skip to main content

Create User

POST 
/v1/users

Create a user from email and role, with optional contact and invitation-template fields. The response contains the created user and invitation message.

Requires users.write.

Request and response fields at a glance
  • Request body (application/json): email (string, required), name (string), role (string, required), organizationId (number), phone (mixed), phoneCountry (mixed), emailTemplate (string), saleChannel (string).
  • 201 response (application/json): id (number, required), email (string, required), name (string), nameAr (mixed), nameEn (mixed), phone (mixed), phoneCountry (mixed), role (string, required), organizationId (number), logoUrl (string), status (string, required), lastSignInAt (mixed, required), createdAt (string, required), updatedAt (string, required), organization (object), permissions (array) or user (object, required), message (string, required).

Request​