Skip to main content
POST
/
party-invitations
/
{invitationId}
/
revoke
Revoke party invitation
curl --request POST \
  --url https://api.natural.co/party-invitations/{invitationId}/revoke \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "type": "invitation",
    "id": "inv_019cd4a832f37c4b8a1d63e94b7c8d12",
    "attributes": {
      "email": "engineer@velocitylogistics.com",
      "role": "MEMBER",
      "status": "PENDING",
      "expiresAt": "2026-01-11T15:30:00Z",
      "createdAt": "2026-01-04T15:30:00Z",
      "acceptedAt": null
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Agent-ID
string | null

Agent ID (agt_xxx) identifying which agent is making the request.

X-Instance-ID
string | null

Required when X-Agent-ID is present. Session or conversation ID for agent observability.

Maximum string length: 1024

Path Parameters

invitationId
string
required

Invitation ID

Response

Successful Response

data
object
required
Example:
{
"type": "invitation",
"id": "inv_019cd4a832f37c4b8a1d63e94b7c8d12",
"attributes": {
"email": "engineer@velocitylogistics.com",
"role": "MEMBER",
"status": "PENDING",
"expiresAt": "2026-01-11T15:30:00Z",
"createdAt": "2026-01-04T15:30:00Z",
"acceptedAt": null
}
}