Zernio
Zernio
API Reference

Meta Business Agent

Setup

Get agent setup statusGETCreate the agentPOSTList agent settingsGETUpdate agent settingsPATCHList allowlisted consumersGETAllowlist a consumerPOSTRemove an allowlisted consumerDELETE

Knowledge

Get business informationGETReplace business informationPUTReset business informationDELETEList FAQsGETCreate a FAQPOSTGet a FAQGETUpdate a FAQPUTDelete a FAQDELETEList crawled websitesGETAdd a website to crawlPOSTGet a crawled websiteGETUpdate a crawled websitePUTRemove a crawled websiteDELETEList knowledge filesGETUpload a knowledge filePOSTGet a knowledge fileGETDelete a knowledge fileDELETE

Skills

List skillsGETCreate a skillPOSTGet a skillGETUpdate a skillPUTDelete a skillDELETEList UI skillsGETCreate a UI skillPOSTGet a UI skillGETUpdate a UI skillPUTDelete a UI skillDELETE

Connectors

List connectorsGETCreate a connectorPOSTGet a connectorGETUpdate a connectorPUTDelete a connectorDELETESet connector credentialsPOSTRefresh MCP connector toolsPOSTGet connector failure logsGETList connector toolsGETCreate a connector toolPOSTGet a connector toolGETUpdate a connector toolPUTDelete a connector toolDELETERun a connector tool oncePOST

Operate

Get usage budgetsGETReplace usage budgetsPUTSend a test messagePOSTSend a business eventPOSTGet a business event statusGETRead evaluation dataGETStart an evaluation runPOST
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Meta Business Agent

Update agent settings

Partial update: fields you omit keep their value. rollout.enabled: true turns the agent on for new conversations; false stops it on every thread. Turning it on for EVERYONE needs a payment method on the Business Agent billable account (Meta accepts the call but delivers nothing without one); ALLOWLISTED_ONLY does not, which is how you test with a few numbers before billing. never_say_phrases replaces the whole list.

PATCH
/v1/accounts/{accountId}/business-agent/settings

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

accountId*string

WhatsApp social account id (the number must be managed through the Cloud API).

Query Parameters

agentId?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

{  "agent_id": "string",  "channel": "string",  "rollout": {    "enabled": true  },  "handoff": {    "enabled": true,    "message": "string",    "message_selection": "DEFAULT"  },  "followup": {    "enabled": true,    "followup_interval_in_seconds": 0,    "message": "string"  },  "ai_audience": "EVERYONE",  "never_say_phrases": [    "string"  ]}
Was this page helpful?

List agent settings

Settings of every agent configured on the number (normally one). Pass `agentId` to read one.

List allowlisted consumers

Consumers the agent answers while `ai_audience` is ALLOWLISTED_ONLY.

rollout?
handoff?
followup?
ai_audience?string

Value in

  • "EVERYONE"
  • "ALLOWLISTED_ONLY"
never_say_phrases?array<string>

Exact phrases the agent must never say; the full replacement list.