v1

latestOpenAPI 3.1.02026-08-065163115.0 KB

Users

Update user

Update role, payment types, and/or delegation settings for an active employee. All fields in the request body are optional.

patch/v1/businesses/{client_id}/users/{user_id}

Path parameters

client_idinteger required

Example:123

The ID of the business.

user_idinteger required

The ID of the user.

Request body

role_idstring uuid

The role to assign to the user. Must belong to the same business.

payment_typesPaymentType[]

The payment types the user can transact with.

out_of_office_modeboolean

Whether the user is out of office. When true, both start and end dates are required.

out_of_office_start_datestring date

First day of the out-of-office period (inclusive).

out_of_office_end_datestring date

Last day of the out-of-office period (inclusive). Must be on or after the start date.

delegate_approverinteger nullable

The user ID to delegate approvals to while out of office. Must belong to the same business and have no overlapping out-of-office period.

expense_delegateinteger[]

Replaces the user's full set of expense assistants with these user IDs. A user can have at most 3 expense assistants. Each ID must belong to the same business, must be a different user (a user cannot be their own expense assistant), and must not be repeated. Expense assistants cannot be chained. A user who is themselves an expense assistant cannot be given assistants, and a user who already has assistants cannot be assigned as one. Omit this field to leave the current assistants unchanged, or send an empty array to remove them all.

Example request

{
  "role_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "payment_types": [
    "cards"
  ],
  "out_of_office_mode": true,
  "out_of_office_start_date": "2026-06-01",
  "out_of_office_end_date": "2026-06-15",
  "delegate_approver": 789,
  "expense_delegate": [
    456,
    789
  ]
}

Response

idinteger

The ID of the user.

first_namestring

The first name of the user.

last_namestring

The last name of the user.

namestring

The full name of the user or the display name if the user has set one.

emailstring email

The email of the user.

rolestring

The role of the user.

role_idstring uuid

The ID of the user's role.

is_deletedboolean

Whether the user is deleted.

createdstring date-time

The date and time when the user was created in UTC.

updatedstring date-time

The date and time when the user was last updated in UTC.

payment_typesPaymentType[]

The payment types the user can transact with.

out_of_office_modeboolean

Whether the user is out of office.

out_of_office_start_datestring date nullable

First day of the out-of-office period (inclusive).

out_of_office_end_datestring date nullable

Last day of the out-of-office period (inclusive).

delegate_approverinteger nullable

The user ID to delegate approvals to while out of office.

expense_delegateinteger[] nullable

The user IDs of this user's expense assistants (who can act on their expenses). Null if the business does not have the expense assistant feature.

Example response

{
  "id": 123,
  "first_name": "John",
  "last_name": "Doe",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "role": "Team Member",
  "role_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "created": "2024-01-01T00:00:00Z",
  "updated": "2024-01-01T00:00:00Z",
  "payment_types": [
    "cards"
  ],
  "out_of_office_mode": true,
  "out_of_office_start_date": "2026-06-01",
  "out_of_office_end_date": "2026-06-15",
  "delegate_approver": 789,
  "expense_delegate": [
    456,
    789
  ]
}