WhatsApp · Business Agent
Allowlists a consumer.
POST
https://api.pozy.ai/v1/accounts/{accountId}/business-agent/allowlistaddBusinessAgentAllowlistEntry
Guide: Business AI agent
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication
Path parameters
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string |
Request body
application/json, required
consumer_phone_numberstringrequired
Example
curl -X POST "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/allowlist" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"consumer_phone_number": "+14155550123"
}'const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/allowlist", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
consumer_phone_number: "+14155550123"
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.post(
"https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/allowlist",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"consumer_phone_number": "+14155550123",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
201 on success
idstringrequiredconsumer_phone_numberstring
201 response
{
"id": "6bfebd43ddc270f6d2c56fc5",
"consumer_phone_number": "+14155550123"
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.
More in Business Agent
GETGet agent setup statusPOSTCreate the agentGETList agent settingsPATCHUpdate agent settingsGETList allowlisted consumersDELRemove an allowlisted consumerGETGet business informationPUTReplace business informationDELReset business informationGETList FAQsPOSTCreate a FAQGETGet a FAQPUTUpdate a FAQDELDelete a FAQGETList crawled websitesPOSTAdd a website to crawlGETGet a crawled websitePUTUpdate a crawled websiteDELRemove a crawled websiteGETList knowledge filesPOSTUpload a knowledge fileGETGet a knowledge fileDELDelete a knowledge fileGETList skillsPOSTCreate a skillGETGet a skillPUTUpdate a skillDELDelete a skillGETList UI skillsPOSTCreate a UI skillGETGet a UI skillPUTUpdate a UI skillDELDelete a UI skillGETList connectorsPOSTCreate a connectorGETGet a connectorPUTUpdate a connectorDELDelete a connectorPOSTSet connector credentialsPOSTRefresh MCP connector toolsGETGet connector failure logsGETList connector toolsPOSTCreate a connector toolGETGet a connector toolPUTUpdate a connector toolDELDelete a connector toolPOSTRun a connector tool onceGETGet usage budgetsPUTReplace usage budgetsPOSTSend a test messagePOSTSend a business eventGETGet a business event statusGETRead evaluation dataPOSTStart an evaluation run