Run scenario with the Make API

Runs an active scenario now, which uses operations of the organization. Returns the executionId; with responsive true it waits up to 40 seconds and also returns the status and the scenario outputs. A paused organization or team answers 429 with code IM310.

Identifier
make_run_scenario

The request

POST https://connect.reportei.com/api/tools/make_run_scenario/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "scenarioId": 1
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
scenarioIdintegerYesId of the scenario, from List scenarios.
dataobjectNoValues of the scenario inputs, by input name. Required when the scenario has required inputs.
responsivebooleanNoSet to true to wait for the end of the run. After 40 seconds the call times out, but the run goes on: follow it with Get scenario execution.

Supported connections

Your customer connects their Make account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

When connecting, your customer also enters {zone}: the address of their account on the app's API.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/make_run_scenario. It becomes your agent's tool definition with no conversion.

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.