WhatsApp · Business Agent

Send a business event

Sends a business event.

POSThttps://api.pozy.ai/v1/accounts/{accountId}/business-agent/events
sendBusinessAgentEvent

Guide: Business AI agent

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
accountIdrequiredstring

Request body

application/json, required

  • tostringrequired
  • typestringrequired

    Up to 256 characters.

  • descriptionstringrequired

    Up to 1024 characters.

  • payloadstringrequired

    Up to 4096 characters.

Example

curl -X POST "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/events" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "+14155550123",
  "type": "string",
  "description": "A short description",
  "payload": "string"
}'

Response

202 on success

  • statusstringrequired
  • agent_event_idstring
202 response
{
  "status": "active",
  "agent_event_id": "6305e71fab938130cac3d22c"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Business Agent