Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
workspace

Delete Existing Invitation

Invalidates an existing email invitation. The invitation will still show up in the inbox it has been delivered to, but activating it to join the workspace won't work. This endpoint may only be called by workspace members with the WORKSPACE_MEMBERS_INVITE permission.

delete/v1/workspace/invites

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

emailstring required

The email of the customer

Example request

{
  "email": "john.doe@testmail.com"
}

Response

Successful Response

statusstring required

The status of the workspace invite deletion request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned.

Example response

{
  "status": "ok"
}