Update an agent

update an AI agent.

PATCH https://api.centerfy.ai/webhooks/inbound/agents/:id

Headers

Header	Required	Value	Description
`x-api-key`	Yes	your sub-account API key (cfy_…)	Authenticates the request; or use Authorization: Bearer `<key>`.
`Content-Type`	Yes	application/json	The request body is JSON.

Path parameters

Name	Type	Required	Description
`id`	`string (uuid)`	Yes	The agent id.

Body parameters

Name	Type	Required	Default	Description
`name`	`string`	No	—	The agent’s display name; if present, must be a non-empty string.
`voice_id`	`string`	No	—	The voice — accepts a friendly voice name (e.g. “Marissa”) or a raw voice id. If present, must be a non-empty string.
`llm_model`	`string`	No	—	The LLM model; if present, must be a non-empty string.
`language`	`string`	No	—	The agent language code; if present, must be a non-empty string.
`max_duration`	`number`	No	—	Maximum call duration; if present, must be a number.
`temperature`	`number`	No	—	LLM sampling temperature; if present, must be a number.
`silence_timeout`	`number`	No	—	Silence timeout; if present, must be a number.
`voice_activity_timeout`	`number`	No	—	Voice-activity timeout; if present, must be a number. The alternate spelling ‘voice_activbity_timeout’ is also accepted.
`background_noise`	`boolean`	No	—	Whether ambient background noise is enabled; if present, must be a boolean. When set to true, ‘background_type’ is required.
`background_type`	`string`	No	—	Ambient noise profile; if present, must be one of: call_center, coffee_shop, conventional_hall. Required when setting background_noise=true.
`voicemail_detection`	`boolean`	No	—	Whether voicemail detection is enabled; if present, must be a boolean. When set to true, ‘voicemail_type’ is required.
`voicemail_type`	`string`	No	—	Voicemail action; if present, must be one of: leave_message, hangup. Required when setting voicemail_detection=true; when ‘leave_message’, ‘voicemail_message’ is required.
`voicemail_message`	`string`	No	—	The message left on voicemail; if present, must be a string. Required when voicemail_type=‘leave_message’.
`backcchanneling`	`boolean`	No	—	Whether backchanneling is enabled; if present, must be a boolean. The alternate spelling ‘backchanneling’ is also accepted.
`is_active`	`boolean`	No	—	Whether the agent is active; if present, must be a boolean.
`webhook`	`boolean`	No	—	Whether an outbound webhook is enabled; if present, must be a boolean. When set to true, ‘webhook_url’ is required.
`webhook_url`	`string`	No	—	The outbound webhook URL; if present, must be a string. Required when setting webhook=true.
`recording`	`boolean`	No	—	Whether call recording is enabled; if present, must be a boolean.

Request body

{
  "name": "Front Desk Assistant (v2)",
  "temperature": 0.6,
  "is_active": false
}

Example

curl -X PATCH "https://api.centerfy.ai/webhooks/inbound/agents/{id}" \
  -H "x-api-key: $CENTERFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Front Desk Assistant (v2)",
  "temperature": 0.6,
  "is_active": false
}'

import { CenterfyClient } from "@centerfy/sdk";

const centerfy = new CenterfyClient({ apiKey: process.env.CENTERFY_API_KEY! });

const result = await centerfy.agents.update("<agentId>", {
  "name": "Front Desk Assistant (v2)",
  "temperature": 0.6,
  "is_active": false
});
console.log(result);

centerfy agents update <agentId> '{"name":"Front Desk Assistant (v2)","temperature":0.6,"is_active":false}'

MCP tool: centerfy_agents_update (see MCP server)

Response

{
  "status": "success",
  "agent": {
    "id": "<agent_id>",
    "name": "Front Desk Assistant (v2)",
    "is_active": false,
    "updated_at": "2026-06-12T10:25:00.000Z"
  }
}

Notes

Partial update — every field is optional, but the body must contain at least one updatable field. Sending one field never wipes the rest; existing configuration is preserved for fields you omit. Errors: 400 (invalid agent id / validation failure / empty body), 401 (unauthenticated), 404 (agent not found), 500 (server error). Success is 200.