Update, Toggle & Delete

Update a tool

PATCH/v2.0/tools/:toolId

A partial update — send only the fields you want to change. The patch is merged over the existing tool and the complete result is re-validated, so type-specific subdocuments stay consistent.

toolType is immutable

You cannot change a tool’s toolType. Sending a different one returns 400 TOOL_TYPE_IMMUTABLE — delete and recreate instead.

Subdocuments replace, not merge

Fields like components, parameters, headers, catalogAction and shopifyAction are replaced as a whole when included. Send the full object, not a partial one. Omit a field entirely to leave it unchanged.

Body (all optional)

Parameter	Type	Required	Description
name	string	Optional	New unique name (lowercase/underscore rules apply).
description	string	Optional	New description.
isActive	boolean	Optional	Enable/disable. Left unchanged if omitted.
…type-specific	object	Optional	Any field for the tool's type — see the Tool Types Reference.

curl -X PATCH https://api.sendiee.com/v2.0/tools/V1StGXR8Z5jdHi \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "description": "Use this whenever the customer asks where their order is." }'

{
  "success": true,
  "data": {
    "toolId": "V1StGXR8Z5jdHi",
    "toolType": "function",
    "isActive": true,
    "…": "updated tool"
  }
}

A 422 validation failure has the same shape as on create. Renaming to a taken name returns 409 TOOL_NAME_EXISTS.

Toggle a tool

POST/v2.0/tools/:toolId/toggle

Enable or disable without a full update. Body is optional — send { "isActive": true|false } to set explicitly, or omit it to flip the current state.

cURL

curl -X POST https://api.sendiee.com/v2.0/tools/V1StGXR8Z5jdHi/toggle \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "isActive": false }'

Delete a tool

DELETE/v2.0/tools/:toolId

Permanently deletes the tool, detaches it from every assistant that references it, refreshes those assistants’ caches, and removes its version history.

cURL

curl -X DELETE https://api.sendiee.com/v2.0/tools/V1StGXR8Z5jdHi \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "data": {
    "toolId": "V1StGXR8Z5jdHi",
    "deleted": true
  }
}