Scenarios > Tools

The following endpoints allow you to manage tools.

Update tool configuration

patch

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/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 underlaying scenario including properties that were not changed.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

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

application/json

namestringOptional

The name of the tool.

descriptionstringOptional

A description of the tool.

inputsobject[]Optional

moduleTypestringOptional

The type of the tool module.

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

patch

/scenarios/tools/{scenarioId}

HTTPcURLJavaScriptPython

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

{
  "name": "New tool name"
}

200

Scenario was updated successfully

{
  "scenario": {
    "id": 925,
    "name": "Dummy tool",
    "teamId": 215,
    "hookId": null,
    "deviceId": null,
    "deviceScope": null,
    "concept": false,
    "description": "This is a dummy tool for testing purposes.",
    "folderId": null,
    "isinvalid": false,
    "islinked": false,
    "isActive": false,
    "islocked": false,
    "isPaused": false,
    "usedPackages": [
      "scenario-service",
      "dummy",
      "scenario-service"
    ],
    "lastEdit": "2021-09-22T06:40:56.692Z",
    "scheduling": {
      "type": "on-demand"
    },
    "iswaiting": false,
    "dlqCount": 0,
    "createdByUser": {
      "id": 985,
      "name": "John Doe",
      "email": "[email protected]"
    },
    "updatedByUser": {
      "id": 986,
      "name": "John Foo",
      "email": "[email protected]"
    },
    "nextExec": "2021-09-22T06:41:56.692Z",
    "created": "2021-10-22T06:41:56.692Z",
    "type": "tool"
  }
}