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.

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

patch/v1/messaging/accounts/{accountId}/business-agent/settings

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/accounts/{accountId}/business-agent/settings
  • Auth: HTTP bearer

Path parameters

accountIdstring required

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

Query parameters

agentIdstring

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

ai_audience'EVERYONE' | 'ALLOWLISTED_ONLY'
never_say_phrasesstring[]

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

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.