Skip to main content
POST
/
customers
/
invitations
Invite customers
curl --request POST \
  --url https://api.natural.co/customers/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "attributes": {
      "recipients": [
        {
          "type": "email",
          "value": "ops@acme.com"
        }
      ],
      "agents": [
        {
          "agentId": "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
          "permissions": [
            "payments.read"
          ],
          "limits": {
            "perTransaction": 100000
          }
        }
      ],
      "expiresAt": "2026-01-12T10:15:00.000Z",
      "tags": {
        "campaign": "q3_reactivation"
      }
    }
  }
}
'
{
  "data": [
    {
      "type": "agentDelegationInvitation",
      "id": "adi_550e8400e29b41d4a716446655440000",
      "attributes": {
        "developerName": "Acme Co",
        "email": "ops@acme.com",
        "phone": null,
        "url": "https://www.natural.co/connect/adi_550e8400e29b41d4a716446655440000",
        "agentName": "Invoice Agent",
        "permissions": [
          "payments.read"
        ],
        "limits": {
          "perTransaction": 100000
        },
        "status": "PENDING",
        "effectiveStatus": "PENDING",
        "expiresAt": "2026-01-12T10:15:00.000Z",
        "acceptedAt": null,
        "declinedAt": null,
        "cancelReason": null,
        "tags": {
          "campaign": "q3_reactivation"
        },
        "createdAt": "2026-01-05T10:15:00.000Z",
        "updatedAt": "2026-01-05T10:15:00.000Z"
      },
      "relationships": {
        "agent": {
          "data": {
            "type": "agent",
            "id": "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f"
          }
        },
        "customerParty": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "failedRecipients": []
  }
}

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

Body

application/json
data
object
required

Resource object

Response

Successful Response

data
AgentDelegationInvitationResource · object[]
required

Created invitations

meta
object
required

Metadata about the batch