Skip to main content
DELETE
/
api
/
v1
/
invitations
/
by-scope
/
{scopeType}
/
{scope}
Delete all invitations by scope
curl --request DELETE \
  --url https://api.example.com/api/v1/invitations/by-scope/{scopeType}/{scope} \
  --header 'x-api-key: <api-key>'
{
  "statusCode": 404,
  "message": "Scope not found",
  "error": "Not Found"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
scopeType
string
required

The name of the entity that the ID passed in scope refers to (e.g., “workspace”, “organization”, “team”). Ensures that you don’t have any issues disambiguating the ID in cases where there are multiple types of entities to which someone can be invited. If your system does not have a scope type, use "default".

​
scope
string
required

The ID in your system of the entity to which the invitation applies (e.g., workspace, team, org, etc.).

Response

Successfully deleted all invitations for the scope