Skip to navigation

Update a robot

Changes any subset of a robot’s fields and settings: its name, your external_id, its description, whether it is active, and its settings, the same ones your customer sees in the ParsChat panel. See the robot settings guide for what each one does.

Only what you send changes, and nested objects merge. {"settings": {"conversations": {"auto_close": {"idle_minutes": 720}}}} keeps enabled as it was, and a working-hours days object changes only the days it names.

A request is all or nothing. If any part is refused, nothing in it is saved. An unknown field is refused rather than ignored, so a typo cannot pass as saved, and null is accepted only for external_id and description, which it clears. An empty body changes nothing.

settings.ai and settings.ai_operator need an AI messages package. Without one they read as null, and a request carrying either answers 403 ai_not_in_plan.

Auto-close. idle_minutes is 15 to 21600 (15 days). With enabled: false a conversation still closes after 15 days without a message. Conversations are closed by an hourly job, so one closes up to about an hour after its limit, with a chat event; a customer who writes again reopens the same conversation.

is_active: false is not a pause. It switches every channel of the robot off, which frees their channel capacity; true does not switch them back on. To stop only the AI, set settings.ai_operator.enabled to false.

Not in this API: the robot’s custom prompt, which changes only through the panel’s prompt assistant, and the AI operator’s avatar.

Authentication

AuthorizationBearer

Your API key, issued by ParsChat sales. One key per account, spanning every robot you own. Send it as Authorization: Bearer pk_live_….

Path parameters

robot_idstringRequired
The robot's id, as returned by the create call.

Request

This endpoint expects an object.
namestringOptional
Display name, 1 to 255 characters.
external_idstring or nullOptional

Your own customer id, 1 to 255 characters, unique across your robots (409 otherwise). null clears it.

descriptionstring or nullOptional

Free text, up to 255 characters. null clears it.

is_activebooleanOptional

false deactivates the robot and switches all its channels off; true reactivates it but leaves the channels off.

settingsobjectOptional

A change to any part of a robot’s settings. Only what you send changes; nested objects merge.

Response

The robot after the change, with all its settings.
idstringOptional
ParsChat identifier for the robot.
namestringOptional
Display name, shown in the panel.
external_idstring or nullOptional

Your own identifier for this customer. Returned on every webhook event, so you do not need a lookup table. null until you set one.

descriptionstring or nullOptional

Free text about the robot, up to 255 characters. null until you set it.

is_activebooleanOptional

false while the robot is deactivated: its channels are switched off. See PATCH /robots/{robot_id}.

channelslist of objectsOptional
Channels attached to this robot, in short form. Empty until you connect one. Call the channels endpoint for the full record.
created_atdatetimeOptional
When the robot was created.
settingsobjectOptional

A robot’s settings, the same ones your customer sees in the ParsChat panel. ai and ai_operator are null for an account without an AI messages package.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error