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": "jsmith@example.com",
  "last_name": "Peters",
  "phone": "<string>",
  "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": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<string>",
  "userpic_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

First name

Maximum string length: 255
Example:

"Casey"

login
string
required
Maximum string length: 255
email
string<email> | null

An entity user business email

last_name
string | null

Last name

Maximum string length: 255
Example:

"Peters"

phone
string | null

An entity user phone number in the international format

role_id
string<uuid> | null

UUID of the role assigned to this entity user

title
string | null

Title

Maximum string length: 255
Example:

"Finance Manager"

Response

Successful Response

id
string<uuid>
required

UUID entity user ID

created_at
string<date-time>
required

UTC datetime

updated_at
string<date-time>
required

UTC datetime

login
string
required

Login

Example:

"caseyp"

role_id
string<uuid>
required

UUID role ID

status
enum<string>
required

record status, 'active' by default

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

An entity user business email

first_name
string

First name

last_name
string | null

Last name

phone
string | null

An entity user phone number in the international format

userpic_file_id
string<uuid> | null