Skip to navigation
EndpointsAuthentication

Register a new user

Creates a new user account and sends an email verification link.

Adding a user to an existing organisation takes one of its seats, and the invited user holds it from the moment they are created, before they accept. At the organisation’s user limit the invite is refused with 409; see seats on GET /api/v1/billing/entitlements.

Request

This endpoint expects an object.
emailstringRequiredformat: "email"
passwordstringRequiredformat: "password">=8 characters
first_namestringRequired<=254 characters
last_namestringRequired<=254 characters
user_typeslist of stringsOptional
Group names to assign to the user
organisation_idinteger or nullOptional
ID of the organisation to associate the user with

Response

User registered successfully
messagestringOptional
userobjectOptional

Errors

400
Bad Request Error
403
Forbidden Error
409
Conflict Error