v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
organization-users

Archive a user

Archive an existing user. In the response, the archived field is set as true."

You can restore an archived user with POST /v3/users/{userId}/restore. There is no change when you archive an archived user.

post/v3/users/{userId}/archive

Path parameters

userIdstring required

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

Example:{{org_user_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Response

Archive 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