Skip to main content
POST
/
entity_users
Create an entity user
curl --request POST \
  --url https://api.sandbox.monite.com/v1/entity_users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "first_name": "<string>",
  "login": "<string>",
  "email": "c.peters@example.com",
  "last_name": "Peters",
  "phone": "+491729925904",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "Finance Manager"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "login": "<string>",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "active",
  "email": "c.peters@example.com",
  "first_name": "<string>",
  "last_name": "Peters",
  "phone": "+491729925904",
  "userpic_file_id": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Body

application/json
​
first_name
string
required

The user's first name.

Maximum string length: 255
Examples:

"Casey"

"Casey"

​
login
string
required

The username assigned to this user. Usernames must be unique within the entity.

The login value is not used by Monite but may be used by partner applications, for example, to map the users between the partner's platform and Monite.

Maximum string length: 255
​
email
string<email> | null

The user's business email address.

Example:

"c.peters@example.com"

​
last_name
string | null

The user's last name.

Maximum string length: 255
Example:

"Peters"

​
phone
string | null

The user's phone number.

Example:

"+491729925904"

​
role_id
string<uuid> | null

ID of the role to assign to this user. The role defines the user's access permissions within the entity. Each user has just one role.

​
title
string | null

The user's job title.

Maximum string length: 255
Example:

"Finance Manager"

Response

Successful Response

​
id
string<uuid>
required

A unique Monite-assigned ID of this entity user. Can be used with POST /auth/token to generate an API access token for this user.

​
created_at
string<date-time>
required

UTC date and time when this user was created in Monite.

​
updated_at
string<date-time>
required

UTC date and time when this user was last updated.

​
login
string
required

The username assigned to this user. Usernames must be unique within the entity.

The login value is not used by Monite but may be used by partner applications, for example, to map the users between the partner's platform and Monite.

Example:

"caseyp"

​
role_id
string<uuid>
required

ID of the role assigned to this user. The role defines the user's access permissions within the entity. Each user has just one role.

​
status
enum<string>
required

The user's status. Always active.

Available options:
active,
deleted
​
email
string<email> | null

The user's business email address.

Example:

"c.peters@example.com"

​
first_name
string

The user's first name.

Example:

"Casey"

​
last_name
string | null

The user's last name.

Example:

"Peters"

​
phone
string | null

The user's phone number.

Example:

"+491729925904"

​
userpic_file_id
string<uuid> | null

Unused. Reserved for future use. Currently always returns null.

Example:

null