VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
List invitations
Send an invitation
Retrieve an invitation
Revoke an invitation

Revoke an invitation

Revokes a pending invitation, so its link stops working.

An app limited to reading cannot revoke invitations.

Guide: Members and roles

DELETE
/api/v1/organizations/{organizationId}/invitations/{invitationId}

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

organizationId*string

The organization's id, org_....

invitationId*string

The invitation's id, inv_....

Examples

curl -X DELETE "https://api.voidhash.com/api/v1/organizations/org_w5xk2e7q0lzv3n8b1c4d6f9g/invitations/inv_c7v0b3n6m9k2j5h8g1f4d7s0" \  -H "Authorization: Bearer vh_sk_..."
Empty
{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}
{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}
{  "error": {    "type": "not_found",    "code": "organization_not_found",    "message": "There is no organization org_w5xk2e7q0lzv3n8b1c4d6f9g, or this credential cannot use it.",    "param": "organizationId"  }}
{  "error": {    "type": "conflict",    "code": "invitation_accepted",    "message": "This invitation was already accepted."  }}
{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Response body

application/json

application/json

application/json

application/json

application/json

application/json

Errors

StatustypecodeWhen
409conflictinvitation_acceptedWhen it was already accepted.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Invitations

  • List invitations GET
  • Send an invitation POST
  • Retrieve an invitation GET

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousRetrieve an invitationNextRetrieve an organization's billing

On this page

AuthorizationPath parametersExamplesResponse bodyErrorsMore in Invitations