Skip to main content
POST
POST /remove_user_access
This endpoint is available in the test environment. It has not been deployed live.
Sets the user’s account role to Remove Access. The profile, user identifier, company association, Staff ID and historical assessment records are retained. This request sends no invitation or notification emails and does not delete the user.

Authorization

string
required
Company Bearer token. Keep it on your server. The token determines which company’s users can be changed.

Body parameters

string
required
The external Staff ID used when inviting the user. It must match exactly one user within the authenticated company. This is separate from the returned Bubble user_id.
No reason, email, company identifier or event identifier is required.

Response and retries

string
success after the role has been set.
boolean
true on success; false on an application error.
string
Remove Access on success.
Repeated calls for an already archived user return the same success response. They do not recreate the account or send emails. Retry the same request after a transport failure if removal is still intended. A later request will remove access again if an administrator has restored the user in the meantime; this endpoint does not deduplicate requests by event ID. To restore access, call Add or restore staff with the existing account email and the same company token, or restore it through the administration screen. This endpoint only changes the account role; it does not revoke the company’s API token, remove the user’s historical approvals, or delete employee assessment data. Clients must enforce the removed role when authorizing protected actions; changing the role is not a promise that every previously issued session has been invalidated.

Error responses

Check the JSON body even when the HTTP status is 200.