Revoke party invitation

curl --request DELETE \
  --url https://api.natural.co/party-invitations/{invitationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>'

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

DELETE

party-invitations

{invitationId}

Revoke party invitation

curl --request DELETE \
  --url https://api.natural.co/party-invitations/{invitationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>'

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

Authorizations

Authorization

string

header

required

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

Headers

Idempotency-Key

string

required

Unique key for idempotent request handling. If a request with the same key was already processed, the original response is returned.

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

InvitationResource · object

required

Show child attributes