Skip to main content
POST
/
party-invitations
/
{invitation_id}
/
revoke
Revoke party invitation
curl --request POST \
  --url https://api.natural.co/party-invitations/{invitation_id}/revoke \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "type": "invitation",
    "id": "inv_019cd4a832f37c4b8a1d63e94b7c8d12",
    "attributes": {
      "email": "engineer@velocitylogistics.com",
      "role": "MEMBER",
      "status": "PENDING",
      "expires_at": "2026-01-11T15:30:00Z",
      "created_at": "2026-01-04T15:30:00Z",
      "accepted_at": 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

Agent session/conversation ID for observability.

Maximum string length: 1024

Path Parameters

invitation_id
string
required

Invitation ID

Response

Successful Response

Single invitation response: {data: {type, id, attributes}}.

data
InvitationResource · object
required

Resource object