Skip to content

Team

Revoke an invite

Revokes the invite. Only owners can revoke admin invites.

DELETE/api/v1/invites/{id}
  • Console only: owner or admin
  • Workspace: X-Tenant-ID

Path parameters

  • iduuidrequired

    Invite id.

    Example
    a3b4c5d6-e7f8-4091-a2b3-c4d5e6f70819

Headers

  • Cookiestringrequired

    The whatsappx_session cookie the app sets when you sign in. Browsers send it automatically; API keys are not accepted on this endpoint.

    Example
    whatsappx_session=…
  • X-Tenant-IDuuidrequired

    Workspace id. Required for session requests. You can pass ?tenant=<id> instead.

    Example
    8d0f6c2e-3b1a-4c55-9a7e-2f4b6d1e9c30

Response

200 OKapplication/json

  • okboolean

    Always true.

Status codes

  • 200OK. The invite was revoked.
  • 400Bad request. The id is not a valid UUID.
  • 401Unauthorized. No signed-in session (unauthorized).
  • 403Forbidden. API keys can never call this endpoint (API keys cannot administer workspaces). A signed-in user who is not an owner or admin gets admin required; a user who is not a member of the workspace gets forbidden. Admins get only owners can revoke admin invites for admin invites.
  • 404Not found. No invite with this id.