Update a User

Update a User with new tags or disable the User and their credentials.

Request body

enabledboolean

Whether the User is enabled and active. Set to false to disable the User.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

Maximum character length for individual keys is 40.
Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

A single User

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

created_bystring

The ID of the application user that created this user.

emailstring

The email address of the application user (max 100 characters).

enabledboolean

Whether the User is enabled and active. Set to false to disable the User.

first_namestring nullable

The first name of the User ID (Max 50 characters).

identitystring nullable

ID of the Identity that the User object was created under.

last_namestring nullable

The last name of the User ID (Max 50 characters).

last_used_datestring date-time

Timestamp of when the user credentials were last used to make an API call.

passwordstring nullable

The password you'll use to authetnicate requests.

role'ROLE_PLATFORM' | 'ROLE_PARTNER' | 'ROLE_MERCHANT'

Details the level of access the User has available.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

Maximum character length for individual keys is 40.
Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

{
  "identity": "IDxxxxxxxxxxxxxxxxxx"
}