API Reference
System Status

Archive a user

post
https://gateway.stage.bill.com/connect/v3/partner/users//archive

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.

This operation requires partner-level permissions.

  • A sessionId header value generated with API partner login
  • An appKey header value
  • The organizationId of the organization
Path Params
string
required
length ≥ 1

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

Headers
string | null

API session ID generated with /v3/partner/login

string | null

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

string | null

BILL-generated ID of the organization

Responses

Updated 7 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago