WhatsApp · Business Agent
Returns agent settings.
GET
https://api.pozy.ai/v1/accounts/{accountId}/business-agent/settingslistBusinessAgentSettings
Guide: Business AI agent
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication
Path parameters
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string |
Query parameters
| Name | Type | Notes |
|---|---|---|
agentId | string |
Example
curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/settings" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/settings", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
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.get(
"https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/settings",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
settingsarray of objectrequired7 child fields
agent_idstringrequiredchannelstringrequiredrolloutobjectrequired1 child field
enabledbooleanrequired
handoffobjectCan be null.
3 child fields
enabledbooleanmessagestringmessage_selectionstringOne of
DEFAULT,AGENT,CUSTOM.
followupobjectCan be null.
3 child fields
enabledbooleanfollowup_interval_in_secondsintegerOne of
0,300,900,1800,3600,7200,28800,86400.messagestring
ai_audiencestringOne of
EVERYONE,ALLOWLISTED_ONLY. Can be null.never_say_phrasesarray of string
200 response
{
"settings": [
{
"agent_id": "61107e42d7605e217d408f43",
"channel": "string",
"rollout": {
"enabled": true
},
"handoff": {
"enabled": true,
"message": "Hello from Pozy",
"message_selection": "DEFAULT"
},
"followup": {
"enabled": true,
"followup_interval_in_seconds": 0,
"message": "Hello from Pozy"
},
"ai_audience": "EVERYONE",
"never_say_phrases": [
"string"
]
}
]
}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 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 agentPATCHUpdate agent settingsGETList allowlisted consumersPOSTAllowlist a consumerDELRemove 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