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

# Update agent settings

`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

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

## Path parameters

- `accountId` string, required: WhatsApp social account id (the number must be managed through the Cloud API).

## Query parameters

- `agentId` string

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Request body

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

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Meta Business Agent settings for one WhatsApp number, as Meta returns them.
    - `channel` string, required
    - `handoff` object, nullable
      - `enabled` boolean: Whether the agent releases the thread after sending its handoff message.
      - `message` string
      - `message_selection` 'DEFAULT' | 'AGENT' | 'CUSTOM'
    - `rollout` object, required
      - `enabled` boolean, required: Whether the agent answers live conversations.
    - `agent_id` string, required
    - `followup` object, nullable
      - `enabled` boolean
      - `message` string
      - `followup_interval_in_seconds` 0 | 300 | 900 | 1800 | 3600 | 7200 | 28800 | 86400
    - `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.
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)