AI Agents

Update a Conversational Agent (persona, instructions, tools, handoff, language and escalation settings).

tools_config is merged: keys omitted in the request keep their stored value. The response always carries concrete values for read_images, read_documents, max_images_per_message (1-3) and max_attachments_per_conversation (1-50). Writing read_images also sets the backing bot's vision_enabled.

Required Scopes: automation:update

patch/api/v1/automation/agents/{agent_id}

Request

  • Base URL: https://api.sendseven.com
  • URL: https://api.sendseven.com/api/v1/automation/agents/{agent_id}
  • Auth: HTTP bearer

Path parameters

agent_idstring required

Request body

instructionsstring nullable
model_tier'standard' | 'advanced' nullable
max_tool_callsinteger nullable
turn_timeout_msinteger nullable
settingsobject nullable
personastring nullable
display_namestring nullable
greeting_messagestring nullable
ai_disclosure_messagestring nullable
ai_disclosure_include_escalationboolean nullable
source_footer_enabledboolean nullable
source_footer_mode'urls_only' | 'urls_and_kb' nullable
source_link_paramsobject nullable
namestring nullable
is_activeboolean nullable

Response

Successful Response

idstring required
bot_idstring required
tenant_idstring required
namestring required
is_activeboolean required
personastring nullable
display_namestring nullable
avatar_urlstring nullable
greeting_messagestring nullable
ai_disclosure_messagestring nullable
ai_disclosure_include_escalationboolean
instructionsstring nullable
model_tierstring
source_footer_enabledboolean
source_footer_modestring
source_link_paramsobject nullable
tools_configobject
handoff_configobject
max_tool_callsinteger required
turn_timeout_msinteger required
settingsobject nullable
contextobject
created_atstring date-time nullable
updated_atstring date-time nullable
publish_state'draft' | 'published'
has_unpublished_changesboolean
draft_updated_atstring date-time nullable
published_atstring date-time nullable

Changes

    • info

      added the new optional request property //