Update an entity user

PATCH

/entity_users/:entity_user_id

Change the specified fields with provided values.

Path parameters

entity_user_idstringRequired

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.

emailstringOptional

An entity user business email

first_namestringOptional<=255 characters

First name

last_namestringOptional<=255 characters

Last name

phonestringOptional

An entity user phone number in the international format

role_idstringOptional

UUID of the role assigned to this entity user

titlestringOptional<=255 characters

Title

Response

Successful Response

idstring

UUID entity user ID

created_atdatetime

UTC datetime

updated_atdatetime

UTC datetime

role_idstring

UUID role ID

status"active" or "deleted"

Allowed values: activedeleted

record status, ‘active’ by default

emailstringOptional

An entity user business email

first_namestringOptional

First name

last_namestringOptional

Last name

phonestringOptional

An entity user phone number in the international format

userpic_file_idstringOptional

Errors

Get all counterparts

Up Next

1	curl -X PATCH https://api.sandbox.monite.com/v1/entity_users/entity_user_id \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{}'

1	{
2	"id": "id",
3	"created_at": "2024-01-15T09:30:00Z",
4	"updated_at": "2024-01-15T09:30:00Z",
5	"login": "caseyp",
6	"role_id": "role_id",
7	"status": "active",
8	"email": "email",
9	"first_name": "first_name",
10	"last_name": "last_name",
11	"phone": "phone",
12	"userpic_file_id": "userpic_file_id"
13	}