Tools

The following endpoints allow you to manage tools.

Update tool configuration

patch

/scenarios/tools/{scenarioId}

Updates a tool configuration with a given scenario ID by passing new values in the request body. Any property that is not provided will be left unchanged. In the response, it returns all details of the updated tool configuration of the underlying scenario, including properties that were not changed.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

scenarioIdintegerRequired

The ID of the scenario. You can get the scenarioId with the List scenarios API call.

Example: 112

Query parameters

Body

namestringOptional

The name of the tool.

descriptionstringOptional

A description of the tool.

inputsobject[]Optional

moduleobjectOptional

The module of the tool. The module is a JSON object that contains the module ID, version, mapper, parameters, and metadata.

Responses

200

Scenario was updated successfully

application/json

403

A module in the blueprint places a locked connection or key the user is not allowed to use (IM002, placement guard). Returned only when locked-entities enforcement is enabled for the organization; an untouched frozen module and releasing a locked entity (swapping it out or removing its module) always pass.

409

The scenario was modified concurrently between the placement-guard check and the save (SC409). The save was not applied; retry the request.

patch/scenarios/tools/{scenarioId}

PATCH /api/v2/scenarios/tools/{scenarioId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "name": "New tool name"
}

{
  "tool": {
    "id": 1,
    "name": "Dummy Tool",
    "description": "This is a dummy tool for testing purposes.",
    "inputs": [],
    "teamId": 1,
    "module": {
      "module": "dummy:ActionDummy",
      "version": 1,
      "mapper": {},
      "parameters": {},
      "metadata": {}
    }
  }
}