Remove a collaborator's access from an account

post

https://api.convert.com/api/v2/accounts/{account_id}/users-accesses/delete

Revokes a user's collaborator access to specified projects within an account, or entirely from the account.
Identifies the ACTIVE collaborator by user_id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

Body Params

Contains the user_id of an ACTIVE collaborator and the project accesses to revoke. Omitting accesses, or sending an empty list, revokes every non-owner access the collaborator holds in the account. An entry with a null project revokes the account-wide access ({account_id}_all) only. Entries that match no existing access are ignored; a request matching none of them returns 404.

Identifies an ACTIVE collaborator. Pending invitations have no user id and are addressed by email through the invitations endpoints.

user_id

string

required

The unique system identifier for an active Convert user.

accesses

array of objects

A list defining the user's access to specific projects or all projects within the account.
Each item specifies a project (ID or null for all projects) and the role granted.

accesses

Responses

200A generic success response, typically used for operations that don't return specific data (like deletions or some updates). The code is usually 200, and message confirms the successful action.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.