Update scenario interface

Required scopes:

• scenarios:write

Updates specification of the scenario inputs. Check out the scenario inputs documentation in the Make help center.

If you want to enable the scenario inputs you have to set the scenario scheduling to "On demand" first, otherwise you get error 422 (IM016). You can use the API call:

PATCH /scenarios/{scenarioId}?confirmed=true

with the request body:

{"scheduling": "{\"type\":\"on-demand\"}"}

You can disable inputs for the specified scenario by sending a payload with an empty input array.

The response contains the updated scenario inputs specification.

The scenario inputs feature requires your account to have the pricing plan Pro or higher. Read more about Make pricing.

PATCHhttps://eu1.make.com/api/v2/scenarios/{scenarioId}/interface

Authorization

token

Path parameters

scenarioId*integer

The ID of the scenario. Get the list of scenarios with the API call GET /scenarios.

Example: 111

Body

application/json

interfaceobject

Contains the input array with specification of the scenario input parameters.

Response

200

Successful response

Body

application/json

interfaceobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://eu1.make.com/api/v2/scenarios/{scenarioId}/interface', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "interface": {
        "input": [
          {
            "name": "userName",
            "type": "text",
            "default": "John Doe",
            "required": true,
            "multiline": false
          },
          {
            "name": "employeeID",
            "type": "number",
            "default": null,
            "required": false
          },
          {
            "name": "enabledApps_array",
            "spec": {
              "type": "text",
              "default": "Salesforce",
              "required": true,
              "multiline": false
            },
            "type": "array"
          },
          {
            "name": "myTestInput4_collection",
            "spec": [
              {
                "name": "accountName",
                "type": "text",
                "default": "John Doe",
                "required": true,
                "multiline": false
              },
              {
                "name": "accountID",
                "type": "number",
                "default": null,
                "required": true
              }
            ],
            "type": "collection"
          }
        ],
        "output": null
      }
    }),
});
const data = await response.json();

Response

200

{}