Actions62
- Agent Actions
- Agent Version Actions
- Board Actions
- Call Actions
- Channel Actions
- Contact Actions
- Conversation Actions
- Credit Actions
- Event Actions
- Phone Number Actions
- Tag Actions
- Task Actions
- Voice Actions
- WhatsApp Actions
Agent → Update
AI-generatedSummary
Update a voice agent's configuration in ContactShip by specifying its ID and the new field values; the update is published immediately affecting new calls but does not overwrite any existing drafts open in the ContactShip UI.
Inputs
- agentId (required) — Select the voice agent to update either from a searchable list or by entering its ID.
- configMode (required) — Choose how to provide the updated agent data: either via individual fields defined in the UI or a raw JSON object matching the API's field names.
- updateFields — When defining fields below, set any combination of the agent's properties such as name, language, voice settings, prompt, conversation purpose, tools, and post-call analysis fields.
- configJson — When using JSON mode, provide a JSON object with the agent fields to update, replacing current values.
- options.stopIfDraftOpen — Optionally halt the update with an error if a draft of the agent is currently open in ContactShip, instead of publishing automatically.
Output shape
a single record representing the updated agent's details returned from the ContactShip API
The update publishes changes immediately so they apply to new calls; if a draft is open in the ContactShip UI, it is not overwritten but stays based on the prior version. Use the stopIfDraftOpen option to prevent overwriting drafts by raising an error. Returned data includes the agent's updated configuration fields.