Entity users

Update an entity user

Change the specified fields with provided values.

patch/entity_users/{entity_user_id}

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/entity_users/{entity_user_id}
  • Auth: HTTP bearer

Path parameters

entity_user_idstring required

Headers

x-monite-versionstring required
x-monite-entity-idstring required

The ID of the entity that owns the requested resource.

Request body

emailstring email

The user's business email address.

first_namestring

The user's first name.

last_namestring

The user's last name.

loginstring

The new username for this user. Must be unique within the entity.

phonestring

The user's phone number.

role_idstring uuid

ID of the new role to assign to this user. The new role takes effect immediately, existing access tokens of this user are not invalidated.

titlestring

The user's job title.

Response

Successful Response

idstring 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_atstring date-time required

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

updated_atstring date-time required

UTC date and time when this user was last updated.

emailstring email

The user's business email address.

first_namestring

The user's first name.

last_namestring

The user's last name.

loginstring 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.

phonestring

The user's phone number.

role_idstring 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'active' | 'deleted' required
userpic_file_idstring uuid

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

Changes

No recorded changes to this operation across all 1 revision of this API.