---
title: "Change the agent's settings, or switch the chat on or off"
method: PATCH
path: "/agent"
tags: ["Agent"]
---

# Change the agent's settings, or switch the chat on or off

`PATCH /agent`

## Request

- Base URL: `https://api.meetdarwin.ai/v1`
- URL: `https://api.meetdarwin.ai/v1/agent`
- Auth: HTTP bearer

Requires the `agent:write` scope.

## Headers

- `Idempotency-Key` string

## Request body

- AgentUpdate
  - `name` string
  - `tone` 'friendly' | 'professional' | 'direct'
  - `greeting` string
  - `intro` string
  - `suggestions` string[]
  - `booking_link` string
  - `business_context` string
  - `allowed_origins` string[]
  - `opening` object
    - `enabled` boolean
    - `headline` string
    - `buttons` object[]
      - `label` string, required
      - `message` string, required
    - `excluded_paths` string[]
  - `automation` object
    - `auto_testing` boolean
    - `auto_launch` boolean
    - `auto_promote` boolean
  - `live` boolean

## Response `200`

OK

- Agent
  - `object` 'agent', required
  - `name` string, required
  - `role` string, required
  - `tone` string, required
  - `greeting` string, required
  - `intro` string, required
  - `suggestions` string[], required
  - `booking_link` string, nullable, required
  - `business_context` string, required
  - `allowed_origins` string[], required
  - `opening` object, required
    - `enabled` boolean, required
    - `headline` string, required
    - `buttons` object[], required
      - `label` string, required
      - `message` string, required
      - `locked` boolean, required
    - `excluded_paths` string[], required
  - `automation` object, required
    - `auto_testing` boolean, required
    - `auto_launch` boolean, required
    - `auto_promote` boolean, required
  - `live` boolean, required
  - `site_key` string, required
  - `embed_snippet` string, required

## Other responses

- `400`: Invalid request (`invalid_request`, `unsupported_version`).
- `401`: Missing or invalid key (`authentication_required`, `invalid_api_key`).
- `402`: The workspace must add a card before the API can be used (`payment_required`).
- `403`: The key lacks the scope (`insufficient_scope`), the feature is off (`feature_disabled`), or the workspace's plan doesn't include it (`plan_required`, with `required_plan`).
- `404`: No such object in this workspace (`not_found`).
- `409`: Conflicts with the current state (`conflict`, `idempotency_key_in_use`), or the change would leave a live agent with no calendar or live form (`goal_required`).
- `422`: Refused by a rule (`unprocessable`, `idempotency_key_reused`).
- `429`: Rate limited (`rate_limited`) or a monthly allowance used (`quota_exceeded`); see Retry-After.

## Changes

- **2026-10-20** `f93b0bcb454a`: 24 info
  - added the optional property `feature` to the response with the `400` status
  - added the optional property `feature` to the response with the `401` status
  - added the optional property `feature` to the response with the `402` status
  - added the optional property `feature` to the response with the `403` status
  - …20 more

[Operation history](https://skmtc.dev/meetdarwin/apis/darwin-api/changes/agent/patch.md)

---

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