v1
latestOpenAPI 3.0.12026-07-24310590875.6 KBpartner
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.
This operation requires partner-level permissions.
- A sessionId header value generated with API partner login
- An appKey header value
- The organizationId of the organization
post/v3/partner/users/{userId}/archive
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}}
Response
Archive a user response