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

Get agent setup status

One read that says where the merchant is: whether the number is eligible, whether the Meta Business Agent terms are accepted, whether an agent exists, whether it is on, and its settings. manualSteps lists what Zernio can verify is still pending (accepting the terms in WhatsApp Manager); unverifiedSteps lists what Meta exposes no state for (the payment method in Billing Hub). Never fails for those pre-setup states; it reports them as flags.

GET
/v1/accounts/{accountId}/business-agent

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).

Response Body

application/json

application/json

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.businessagent.getBusinessAgentStatus({  path: {    accountId: 'account_abc123',  },});console.log(data);
{  "eligible": true,  "termsAccepted": true,  "onboarded": true,  "enabled": true,  "agentId": "string",  "settings": {    "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"    ]  },  "manualSteps": [    {      "step": "accept_terms",      "url": "http://example.com",      "description": "string"    }  ],  "unverifiedSteps": [    {      "step": "attach_payment_method",      "url": "http://example.com",      "description": "string"    }  ]}
Was this page helpful?

Reserve an available iMessage number

Holds the number for 3 minutes so nobody else can order it while the buyer decides. Place the order (POST /v1/imessage/senders/order with availableNumberId) before the hold expires. No request body.

Create the agent

Creates the Meta Business Agent on the number and schedules Meta's data preparation. Requires the terms to be accepted; eligibility is checked first and an ineligible number answers 403 `business_agent_not_eligible`. Not idempotent: call it once, then configure knowledge and skills, then enable it through the settings. Configuration calls made in the first minute can still answer `business_agent_not_found` while Meta prepares the workspace.