workspace

Delete Existing Invitation

Changed on

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

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/workspace/invites
  • Auth
    none declared

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.

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"
}

Changes

  • 5b595807512cRevision changes
    • info

      api operation id Delete_existing_invitation_v1_workspace_invites_delete removed and replaced with delete_invite

  • 503db4198a44Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      header request parameter xi-api-key list-of-types was widened by adding types null

    • info

      for the header request parameter xi-api-key, the type was generalized from string to no type

    • info

      added the required property to the response with the status