ContactShip icon

ContactShip

Make AI phone calls, manage contacts, boards and tasks, and send WhatsApp messages with ContactShip

Agent Version → Update Draft

AI-generated

Summary

Update the draft version of a specified voice agent by modifying its configuration fields, without affecting the live published version until the draft is published.

Inputs

  • agentId (required) — The ID or selection of the voice agent to update the draft for.
  • configMode (required) — Choose whether to update the draft by defining individual fields or by providing the entire agent configuration in JSON format.
  • updateFields — If defining fields individually (configMode 'define'), specify each configurable property to update for the draft, such as language, voice model, ambient sound, prompt, voice speed, and other agent behavior settings.
  • configJson — If using JSON mode (configMode 'json'), provide the full agent configuration as a JSON object with API field names to update the draft.

Output shape

a single updated agent draft object representing the modified draft configuration of the specified voice agent.

The operation updates the draft which is not live until explicitly published via the publish operation. If no draft exists, this operation opens a draft from the current published version before updating. Booking tools cannot be modified in a draft. The returned data contains the draft state after modification.

Examples

Example 1: Update the draft of an agent by setting the name and language

Provide agentId, select 'Define Below' mode and supply updateFields with 'name' and 'language'.

Example 2: Update the draft with a custom JSON configuration

Provide agentId, select 'Using JSON' mode, and supply the full agent configuration JSON in 'configJson'.

Links

Discussion