Skip to main content
POST
Create a user
If you set active to true, KODE sends an email to the address you provide, with a link to set a password. Check the email address before you send the request. If you set active to false, the user is created disabled and no email is sent.To activate the user later, use Update the status of a user.
The new user is always an INTERNAL user and has no app access. To give access, call Assign an app to a user with the _id from the response.
The email address must be unique in your organization, and the API stores it in lower case. A second request with the same address, in any letter case, fails with 400. Names can have up to 40 characters, and position up to 200. phone must be an international number that starts with +. Values that contain HTML tags are stored HTML-escaped.

Authorizations

Authorization
string
header
required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Body

application/json
firstName
string
required
Maximum string length: 40
Pattern: \S
lastName
string
required
Maximum string length: 40
Pattern: \S
email
string
required
Pattern: \S
role
string
required
Pattern: \S
active
boolean
required
phone
string
position
string
Maximum string length: 200

Response

The created user. The response is 200, not 201.

_id
string
organizationId
string
createdAt
string
read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

updatedAt
string
read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

firstName
string
lastName
string
email
string
phone
string
position
string
role
string
memberType
string
active
boolean
invitationStatus
string
assignedInApps
object[]