v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

partner

Update a user

Update details about an existing user.

This operation requires partner-level permissions.

A sessionId header value generated with API partner login
An appKey header value
The organizationId of the organization

patch/v3/partner/users/{userId}

Path parameters

userIdstring required

BILL-generated ID of the user. The value begins with 006.

Example:{{partner_user_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/partner/login

Example:{{partner_session_id}}

appKeystring nullable

Application key sent to you by BILL when you create a partner account

Example:{{app_key}}

organizationIdstring nullable

BILL-generated ID of the organization

Example:{{partner_organization_id}}

Request body

firstNamestring

User first name

lastNamestring

User last name

emailstring

User email address

roleIdstring

BILL-generated ID of the user role. The value begins with 0po.

If you do not set roleId, the default ADMINISTRATOR user role is assigned to the created user. You can get the list of available user roles with GET /v3/partner/roles.

Example request

{
  "lastName": "Soupsmithson"
}

Response

Update a user response

idstring

BILL-generated ID of the user. The value begins with 006.

archivedboolean

Set as true if the user is archived

firstNamestring

User first name

lastNamestring

User last name

emailstring

User email address

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time