---
title: "Update agent settings"
method: PATCH
path: "/v1/accounts/{accountId}/business-agent/settings"
tags: ["Business Agent"]
---

# Update agent settings

`PATCH /v1/accounts/{accountId}/business-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.

## Path parameters

- `accountId` string, required

## Query parameters

- `agentId` string

## Request body

- object
  - `rollout` object
    - `enabled` boolean, required
  - `handoff` object
    - `enabled` boolean, required
    - `message` string
    - `message_selection` 'DEFAULT' | 'AGENT' | 'CUSTOM'
  - `followup` object
    - `enabled` boolean, required
    - `followup_interval_in_seconds` 0 | 300 | 900 | 1800 | 3600 | 7200 | 28800 | 86400
    - `message` string
  - `ai_audience` 'EVERYONE' | 'ALLOWLISTED_ONLY'
  - `never_say_phrases` string[] — Exact phrases the agent must never say; the full replacement list.

## Response `200`

Updated settings

- BusinessAgentSettings — Meta Business Agent settings for one WhatsApp number, as Meta returns them.
  - `agent_id` string, required
  - `channel` string, required
  - `rollout` object, required
    - `enabled` boolean, required — Whether the agent answers live conversations.
  - `handoff` object, nullable
    - `enabled` boolean — Whether the agent releases the thread after sending its handoff message.
    - `message` string
    - `message_selection` 'DEFAULT' | 'AGENT' | 'CUSTOM'
  - `followup` object, nullable
    - `enabled` boolean
    - `followup_interval_in_seconds` 0 | 300 | 900 | 1800 | 3600 | 7200 | 28800 | 86400
    - `message` string
  - `ai_audience` 'EVERYONE' | 'ALLOWLISTED_ONLY' | 'null', nullable — EVERYONE answers all consumers; ALLOWLISTED_ONLY answers only the allowlist and needs no payment method.
  - `never_say_phrases` string[] — Exact phrases the agent must never say.

## Other responses

- `400` — Invalid request
- `401` — Unauthorized
- `403` — Inbox add-on required, the WhatsApp token lacks the Business Agent permissions (code reconnect_required), or the merchant has not accepted the Meta Business Agent terms in WhatsApp Manager (code business_agent_terms_not_accepted).
- `404` — Account not found, or no agent exists on the number yet or the referenced item does not exist (code business_agent_not_found).

## Changes

- **2026-09-25** `2c04683ce694` — 12 info
  - added the optional property `details/adAccountId` to the response with the `400` status
  - added the optional property `details/adAccountId` to the response with the `403` status
  - added the optional property `details/adAccountId` to the response with the `404` status
  - added the optional property `details/createdObjects` to the response with the `400` status
  - …8 more
- **2026-09-16** `3e6ddf2a99ea` — 3 info
  - added the optional property `details/budgetScope` to the response with the `400` status
  - added the optional property `details/budgetScope` to the response with the `403` status
  - added the optional property `details/budgetScope` to the response with the `404` status
- **2026-09-15** `0dba7d004d75` — 6 info
  - added the optional property `details/quotaExhausted` to the response with the `400` status
  - added the optional property `details/quotaExhausted` to the response with the `403` status
  - added the optional property `details/quotaExhausted` to the response with the `404` status
  - added the optional property `details/quotaScope` to the response with the `400` status
  - …2 more
- **2026-09-09** `41eff0cffb2d` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/zernio/apis/zernio-api/changes/v1/accounts/:accountId/business-agent/settings/patch.md)

---

[API](https://skmtc.dev/zernio/apis/zernio-api.md) · [All operations](https://skmtc.dev/zernio/apis/zernio-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zernio/apis/zernio-api/revisions/e0122970214f?raw)