Update an agent | Synthflow

Use this endpoint to update an agent's name, phone number, or other parameters. Only the provided parameters will be updated, and others won't be removed or changed.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

model_idstringRequired

Agent ID. You can find it on the agent’s page in your dashboard.

Request

This endpoint expects an object.

descriptionstringOptional

Agent description.

phone_numberstringOptional

The phone number attached to the agent.

external_webhook_urlstringOptional

URL of the webhook that should receive data after the call, such as the transcript.

is_recordingbooleanOptional

Whether the conversation should be recorded.

max_durationobjectOptional

voicemail_messageobjectOptional

Configuration for the message left when a voicemail is detected. Requires greeting_message_mode to be set to human.

namestringOptional

Agent name.

agentobjectOptional

end_call_reasonslist of stringsOptionalDeprecated

Deprecated: use end_call_reasons_v2 instead. Custom conditions that trigger automatic call termination (simple string array format).

Response

200

statusstring

Whether the request was successful.

responseobject

detailsobject

Errors

400

Bad Request Error

Bearer authentication of the form Bearer <token>, where token is your auth token.

Agent ID. You can find it on the agent’s page in your dashboard.

This endpoint expects an object.

The phone number attached to the agent.

URL of the webhook that should receive data after the call, such as the transcript.

Whether the conversation should be recorded.

Configuration for the message left when a voicemail is detected. Requires greeting_message_mode to be set to human.

Deprecated: use end_call_reasons_v2 instead. Custom conditions that trigger automatic call termination (simple string array format).

Whether the request was successful.

$	curl -X PUT https://api.synthflow.ai/v2/assistants/1726005822670x239735712159542050 \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Cindy",
>	"agent": {
>	"noise_cancellation": "advanced",
>	"llm": "gpt-4.1-Mini",
>	"language": "multi"
>	}
>	}'

1	{
2	"status": "ok",
3	"response": {
4	"model_id": "1726005822670x239735712159542050"
5	},
6	"details": {
7	"phone": "",
8	"voice": ""
9	}
10	}

$	curl -X PUT https://api.synthflow.ai/v2/assistants/1726005822670x239735712159542050 \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Cindy",
>	"agent": {
>	"noise_cancellation": "advanced",
>	"llm": "gpt-4.1-Mini",
>	"language": "multi"
>	}
>	}'

1	{
2	"status": "ok",
3	"response": {
4	"model_id": "1726005822670x239735712159542050"
5	},
6	"details": {
7	"phone": "",
8	"voice": ""
9	}
10	}