Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
users

Update a user

Update details about an existing user.

patch/v3/spend/users/{userId}

Path parameters

userIdstring required

BILL-generated ID or UUID of the user

Example:{{se_user_uuid}}

Headers

apiTokenstring nullable

Access token for Spend & Expense API authentication

Example:{{api_token}}

Request body

firstNamestring

User first name

lastNamestring

User last name

emailstring

User email address

role'ADMIN' | 'AUDITOR' | 'BOOKKEEPER' | 'MEMBER'

User role.

  • ADMIN: The user manages the account with full access to settings, people, and activity.
  • AUDITOR: The user can view account activity and export activity for use in other systems.
  • BOOKKEEPER: The user helps the ADMIN with account management, and has view-only access to activity.
  • MEMBER: The user is able to spend company funds for assigned budgets.
dateOfBirthstring date

User date of birth. The value is in the yyyy-MM-dd format.

phoneNumberstring

User phone number

Example request

{
  "role": "ADMIN"
}

Response

Update a user response

idstring

BILL-generated ID of the user

uuidstring

BILL-generated UUID of the user

firstNamestring

User first name

lastNamestring

User last name

emailstring

User email address

receiptEmailstring

Receipt categorization email address

retiredboolean

Set as true if the user is deleted

useCompanyMailingAddressboolean

Set as true if the company email address is set for the user

smsOptInboolean

Set as true if SMS notifications are enabled for the user

hasDateOfBirthboolean

Set as true if the user date of birth is set

role'ADMIN' | 'APPROVER' | 'AUDITOR' | 'BOOKKEEPER' | 'MEMBER' | 'FINANCE_ADMIN' | 'NO_ACCESS'

User role

phoneNumberstring

User phone number

createdTimestring date-time

User created date and time