Create User

Time	Status	User Agent
Retrieving recent requests…

Authorization

This endpoint requires Authorization.

Key	Type	Description	Required
email	string	Email address for the new user. Must be unique across all organizations under this partner.	Yes
name	string	Display name for the new user.	Yes
group_ids	array	List of group UUIDs to assign the user to. At least one group is required.	Yes

{
  "email": "[email protected]",
  "name": "Jane Doe",
  "group_ids": ["269ec8e1-f599-4918-a36b-424aaeef6b83"]
}

Returns the created user:

Key	Type	Description
id	string	Unique identifier of the new user (UUID).
name	string	Display name of the user.
email	string	Email address of the user.
group_names	array	Names of the groups the user was assigned to.
deactivated_at	datetime	Always `null` for a newly created user.
created_at	datetime	Timestamp when the user was created.

📘
Note
The user will receive a welcome email with instructions to set their password.

Status	Message	Description
422	Email can't be blank	The `email` field is missing.
422	Email is not an email	The `email` value is not a valid email address.
422	You have to assign the user at least to one group	The `group_ids` field is missing or empty.
422	The user {email} is already associated with another account	The email is already registered in another organization under this partner.