WhatsApp · Business Agent

Get agent setup status

Fetches agent setup status.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/business-agent

getBusinessAgentStatus

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
`accountId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent", {
  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",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

eligiblebooleanrequired
Can be null.
termsAcceptedbooleanrequired
onboardedbooleanrequired
enabledbooleanrequired
agentIdstringrequired
Can be null.
settingsobjectrequired
One of:
Business Agent Settings (7 fields)
- agent_idstringrequired
- channelstringrequired
- rolloutobjectrequired
  1 child field
  enabledbooleanrequired
- handoffobject
  Can be null.
  3 child fields
  enabledboolean
  messagestring
  message_selectionstring
  One of DEFAULT, AGENT, CUSTOM.
- followupobject
  Can be null.
  3 child fields
  enabledboolean
  followup_interval_in_secondsinteger
  One of 0, 300, 900, 1800, 3600, 7200, 28800, 86400.
  messagestring
- ai_audiencestring
  One of EVERYONE, ALLOWLISTED_ONLY. Can be null.
- never_say_phrasesarray of string
manualStepsarray of objectrequired
- stepstringrequired
  One of accept_terms.
- urlstring (URL)required
- descriptionstringrequired
unverifiedStepsarray of objectrequired
- stepstringrequired
  One of attach_payment_method.
- urlstring (URL)required
- descriptionstringrequired

200 response

{
  "eligible": true,
  "termsAccepted": true,
  "onboarded": true,
  "enabled": true,
  "agentId": "6b99fbd950277956c14bd44d",
  "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"
    ]
  },
  "manualSteps": [
    {
      "step": "accept_terms",
      "url": "https://pozy.ai/media/example-1.jpg",
      "description": "A short description"
    }
  ],
  "unverifiedSteps": [
    {
      "step": "attach_payment_method",
      "url": "https://pozy.ai/media/example-1.jpg",
      "description": "A short description"
    }
  ]
}

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

POSTCreate the agent GETList agent settings PATCHUpdate agent settings GETList allowlisted consumers POSTAllowlist a consumer DELRemove an allowlisted consumer GETGet business information PUTReplace business information DELReset business information GETList FAQs POSTCreate a FAQ GETGet a FAQ PUTUpdate a FAQ DELDelete a FAQ GETList crawled websites POSTAdd a website to crawl GETGet a crawled website PUTUpdate a crawled website DELRemove a crawled website GETList knowledge files POSTUpload a knowledge file GETGet a knowledge file DELDelete a knowledge file GETList skills POSTCreate a skill GETGet a skill PUTUpdate a skill DELDelete a skill GETList UI skills POSTCreate a UI skill GETGet a UI skill PUTUpdate a UI skill DELDelete a UI skill GETList connectors POSTCreate a connector GETGet a connector PUTUpdate a connector DELDelete a connector POSTSet connector credentials POSTRefresh MCP connector tools GETGet connector failure logs GETList connector tools POSTCreate a connector tool GETGet a connector tool PUTUpdate a connector tool DELDelete a connector tool POSTRun a connector tool once GETGet usage budgets PUTReplace usage budgets POSTSend a test message POSTSend a business event GETGet a business event status GETRead evaluation data POSTStart an evaluation run