Skip to main content
DELETE
/
agents
/
{agentId}
/
customers
/
{customerId}
Revoke customer invitation
curl --request DELETE \
  --url https://api.natural.co/agents/{agentId}/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>'
{
  "data": {
    "type": "customerInvitation",
    "id": "pty_4a8c9823f39c42a5b817556766551112",
    "attributes": {
      "name": "Acme Co",
      "email": "ops@example.com",
      "status": "REVOKED",
      "permissions": [
        "payments.create",
        "payments.read"
      ],
      "limits": {
        "perTransaction": 100000
      },
      "createdAt": "2026-01-11T12:00:00.000Z",
      "updatedAt": "2026-01-11T12:00:00.000Z"
    },
    "relationships": {
      "agent": {
        "data": {
          "type": "agent",
          "id": "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
          "attributes": {
            "name": "Carrier Payment Agent"
          }
        }
      }
    }
  },
  "meta": {
    "deleted": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.natural.co/llms.txt

Use this file to discover all available pages before exploring further.

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

agentId
string
required

Agent ID

Pattern: ^agt_[0-9a-f]{32}$
customerId
string
required

Customer party ID

Pattern: ^pty_[0-9a-f]{32}$

Response

Successful Response

data
AgentCustomerResource · object
required
meta
DeletedMeta · object
required