Remove accesses from a pending invitation

post

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

Removes the listed accesses from a pending invitation identified by email. No email is
sent. If accesses is omitted or empty, or if any entry has a null/empty project, the
whole invitation is deleted. If every stored access is removed the invitation is deleted as
well; otherwise the remaining accesses are kept. Returns 404 if no pending invitation exists
for that email.

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 pending invitee's email and the accesses to revoke. Omit accesses, send an empty list, or send an entry with a null/empty project to delete the whole invitation. No email is sent.

Accesses to revoke from the invitation. Omitting accesses, sending an empty array, or
sending an entry whose project is null/empty deletes the entire invitation. An entry
with project: "all" removes only the account-wide access tuple.

string

required

length ≤ 100

The email address of the collaborator or invitee.

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.