Invite customers
curl --request POST \
--url https://api.natural.com/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",
"message": "We use Natural to let our agents help manage payments for your business.",
"tags": {
"campaign": "q3_reactivation"
}
}
}
}
'import requests
url = "https://api.natural.com/customers/invitations"
payload = { "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",
"message": "We use Natural to let our agents help manage payments for your business.",
"tags": { "campaign": "q3_reactivation" }
} } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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',
message: 'We use Natural to let our agents help manage payments for your business.',
tags: {campaign: 'q3_reactivation'}
}
}
})
};
fetch('https://api.natural.com/customers/invitations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.natural.com/customers/invitations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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',
'message' => 'We use Natural to let our agents help manage payments for your business.',
'tags' => [
'campaign' => 'q3_reactivation'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.natural.com/customers/invitations"
payload := strings.NewReader("{\n \"data\": {\n \"attributes\": {\n \"recipients\": [\n {\n \"type\": \"email\",\n \"value\": \"ops@acme.com\"\n }\n ],\n \"agents\": [\n {\n \"agentId\": \"agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f\",\n \"permissions\": [\n \"payments.read\"\n ],\n \"limits\": {\n \"perTransaction\": 100000\n }\n }\n ],\n \"expiresAt\": \"2026-01-12T10:15:00.000Z\",\n \"message\": \"We use Natural to let our agents help manage payments for your business.\",\n \"tags\": {\n \"campaign\": \"q3_reactivation\"\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.natural.com/customers/invitations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"attributes\": {\n \"recipients\": [\n {\n \"type\": \"email\",\n \"value\": \"ops@acme.com\"\n }\n ],\n \"agents\": [\n {\n \"agentId\": \"agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f\",\n \"permissions\": [\n \"payments.read\"\n ],\n \"limits\": {\n \"perTransaction\": 100000\n }\n }\n ],\n \"expiresAt\": \"2026-01-12T10:15:00.000Z\",\n \"message\": \"We use Natural to let our agents help manage payments for your business.\",\n \"tags\": {\n \"campaign\": \"q3_reactivation\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.natural.com/customers/invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"attributes\": {\n \"recipients\": [\n {\n \"type\": \"email\",\n \"value\": \"ops@acme.com\"\n }\n ],\n \"agents\": [\n {\n \"agentId\": \"agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f\",\n \"permissions\": [\n \"payments.read\"\n ],\n \"limits\": {\n \"perTransaction\": 100000\n }\n }\n ],\n \"expiresAt\": \"2026-01-12T10:15:00.000Z\",\n \"message\": \"We use Natural to let our agents help manage payments for your business.\",\n \"tags\": {\n \"campaign\": \"q3_reactivation\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"type": "agentDelegationInvitation",
"id": "adi_550e8400e29b41d4a716446655440000",
"attributes": {
"developerName": "Acme Co",
"email": "ops@acme.com",
"phone": null,
"url": "https://www.natural.com/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": []
}
}{
"errors": [
{
"code": "invalid_value",
"detail": "The information you entered isn't valid. Please check it and try again.",
"status": "400",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "unauthenticated",
"detail": "Authentication is required.",
"status": "401",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "forbidden",
"detail": "You do not have permission to perform this action.",
"status": "403",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "not_found",
"detail": "The requested resource was not found.",
"status": "404",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "conflict",
"detail": "The request conflicts with the current resource state.",
"status": "409",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "invalid_value",
"detail": "The information you entered isn't valid. Please check it and try again.",
"status": "422",
"source": {
"pointer": "/data/attributes/email"
},
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "mfa_required",
"detail": "MFA verification required",
"status": "428",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "rate_limited",
"detail": "Too many requests. Please try again later.",
"status": "429",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "server_error",
"detail": "Something went wrong.",
"status": "500",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "not_implemented",
"detail": "This operation is not available.",
"status": "501",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "bad_gateway",
"detail": "We couldn't complete that request because one of Natural's services returned an unexpected response. Please try again.",
"status": "502",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "service_unavailable",
"detail": "The service is temporarily unavailable.",
"status": "503",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}Customers
Invite customers
Invite specific customers by email or phone to approve a set of your agents, each with its own permissions and limits
POST
/
customers
/
invitations
Invite customers
curl --request POST \
--url https://api.natural.com/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",
"message": "We use Natural to let our agents help manage payments for your business.",
"tags": {
"campaign": "q3_reactivation"
}
}
}
}
'import requests
url = "https://api.natural.com/customers/invitations"
payload = { "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",
"message": "We use Natural to let our agents help manage payments for your business.",
"tags": { "campaign": "q3_reactivation" }
} } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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',
message: 'We use Natural to let our agents help manage payments for your business.',
tags: {campaign: 'q3_reactivation'}
}
}
})
};
fetch('https://api.natural.com/customers/invitations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.natural.com/customers/invitations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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',
'message' => 'We use Natural to let our agents help manage payments for your business.',
'tags' => [
'campaign' => 'q3_reactivation'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.natural.com/customers/invitations"
payload := strings.NewReader("{\n \"data\": {\n \"attributes\": {\n \"recipients\": [\n {\n \"type\": \"email\",\n \"value\": \"ops@acme.com\"\n }\n ],\n \"agents\": [\n {\n \"agentId\": \"agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f\",\n \"permissions\": [\n \"payments.read\"\n ],\n \"limits\": {\n \"perTransaction\": 100000\n }\n }\n ],\n \"expiresAt\": \"2026-01-12T10:15:00.000Z\",\n \"message\": \"We use Natural to let our agents help manage payments for your business.\",\n \"tags\": {\n \"campaign\": \"q3_reactivation\"\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.natural.com/customers/invitations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"attributes\": {\n \"recipients\": [\n {\n \"type\": \"email\",\n \"value\": \"ops@acme.com\"\n }\n ],\n \"agents\": [\n {\n \"agentId\": \"agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f\",\n \"permissions\": [\n \"payments.read\"\n ],\n \"limits\": {\n \"perTransaction\": 100000\n }\n }\n ],\n \"expiresAt\": \"2026-01-12T10:15:00.000Z\",\n \"message\": \"We use Natural to let our agents help manage payments for your business.\",\n \"tags\": {\n \"campaign\": \"q3_reactivation\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.natural.com/customers/invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"attributes\": {\n \"recipients\": [\n {\n \"type\": \"email\",\n \"value\": \"ops@acme.com\"\n }\n ],\n \"agents\": [\n {\n \"agentId\": \"agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f\",\n \"permissions\": [\n \"payments.read\"\n ],\n \"limits\": {\n \"perTransaction\": 100000\n }\n }\n ],\n \"expiresAt\": \"2026-01-12T10:15:00.000Z\",\n \"message\": \"We use Natural to let our agents help manage payments for your business.\",\n \"tags\": {\n \"campaign\": \"q3_reactivation\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"type": "agentDelegationInvitation",
"id": "adi_550e8400e29b41d4a716446655440000",
"attributes": {
"developerName": "Acme Co",
"email": "ops@acme.com",
"phone": null,
"url": "https://www.natural.com/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": []
}
}{
"errors": [
{
"code": "invalid_value",
"detail": "The information you entered isn't valid. Please check it and try again.",
"status": "400",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "unauthenticated",
"detail": "Authentication is required.",
"status": "401",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "forbidden",
"detail": "You do not have permission to perform this action.",
"status": "403",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "not_found",
"detail": "The requested resource was not found.",
"status": "404",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "conflict",
"detail": "The request conflicts with the current resource state.",
"status": "409",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "invalid_value",
"detail": "The information you entered isn't valid. Please check it and try again.",
"status": "422",
"source": {
"pointer": "/data/attributes/email"
},
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "mfa_required",
"detail": "MFA verification required",
"status": "428",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "rate_limited",
"detail": "Too many requests. Please try again later.",
"status": "429",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "server_error",
"detail": "Something went wrong.",
"status": "500",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "not_implemented",
"detail": "This operation is not available.",
"status": "501",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "bad_gateway",
"detail": "We couldn't complete that request because one of Natural's services returned an unexpected response. Please try again.",
"status": "502",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}{
"errors": [
{
"code": "service_unavailable",
"detail": "The service is temporarily unavailable.",
"status": "503",
"meta": {
"supportId": "req_a1b2c3d4e5f6"
}
}
]
}Authorizations
Bearer authentication: send your API key, agent key, or OAuth access token as Authorization: Bearer <credential>.
Headers
Deprecated: agent identity comes from the credential. Sending this header with a party API key or user credential returns 403 agent_credential_required.
Maximum string length:
36Pattern:
^agt_[0-9a-f]{32}$Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.
Maximum string length:
1024Body
application/json
Show child attributes
Show child attributes
Was this page helpful?
⌘I