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

Send a test message

Runs the message through the full agent pipeline in Meta sandbox with no WhatsApp user and no token billing. Pass back conversationId to continue a thread. Meta rate-limits it per number per hour.

POST
/v1/accounts/{accountId}/business-agent/test-messages

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

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

{  "message_id": "string",  "agent_response": "string",  "conversation_id": "string",  "timestamp": 0,  "handoff_reason": "string",  "no_response_reason": "string",  "quick_replies": [    "string"  ],  "product_variant_ids": [    "string"  ]}
Was this page helpful?

Replace usage budgets

The full desired set: budgets left out are removed, an empty list returns to unlimited. Pass `budget_id` to edit one in place. When a cap is hit the agent finishes its turn, stops answering and hands the thread to a human until the window rolls over.

Send a business event

Tell the agent something happened in your systems (order shipped, document verified) so it messages the consumer about it. The consumer must already have a conversation with the number. Answers 202 with the event id; poll it for the outcome.

message*string
Lengthlength <= 4096
conversationId?string