Vapi icon

Vapi

Interact with the Vapi voice AI platform

Squad → Update

AI-generated

Summary

Update a squad by its ID with new values for name, members, membersOverrides, or advanced JSON overrides in the Vapi voice AI platform.

Inputs

  • Squad ID (required) — The unique ID of the Vapi squad to update.
  • Update Fields — Fields to update including name, members as a JSON array, membersOverrides as JSON, squadOverrides as JSON, and an optional Advanced Raw Body JSON to override or add fields.

Output shape

a single JSON object representing the updated squad or an error object if the update fails.

The operation sends a PATCH request to /squad/{id} endpoint with structured fields merged with optional Raw Body JSON. If the update succeeds, the updated squad object is returned. Errors are returned as JSON error details; the node supports continue-on-fail to handle partial failures.

Examples

Example 1: Update squad name and members

Specify the Squad ID, set new name and a JSON array of members in Update Fields.

Example 2: Apply advanced overrides to squad

Provide Squad ID and add JSON objects to membersOverrides, squadOverrides, or rawBody fields to customize the update with advanced routing or configuration.

Links

Discussion