Update scenario with the Make API
Renames a scenario. The name does not need to be unique.
- Identifier
- make_update_scenario
The request
POST https://connect.reportei.com/api/tools/make_update_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,
"name": "<name>"
}
}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
| Parameter | Type | Required | Description |
|---|---|---|---|
| scenarioId | integer | Yes | Id of the scenario, from List scenarios. |
| name | string | Yes | New name of the scenario. |
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_update_scenario. It becomes your agent's tool definition with no conversion.
Other Make tools
- List organizationsGETLists the organizations of the user, each with its id and name. The id is the organizationId the other tools ask for.
- List teamsGETLists the teams of an organization, each with its id and name. The id is the teamId of List scenarios.
- List scenariosGETLists the scenarios of a team or of a whole organization: send teamId or organizationId, never both. Each item has the id and name of the scenario.
- Get scenarioGETReturns the details of one scenario, such as its name, team, scheduling and whether it is active.
- Activate scenarioPOSTActivates a scenario so it runs on its schedule. A scenario scheduled at regular intervals also runs right away.
- Deactivate scenarioPOSTDeactivates a scenario, which stops its schedule and the run in progress, if there is one.
- Run scenarioPOSTRuns 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.
- List scenario logsGETLists the execution logs of a scenario, newest first, each with the execution id, status, duration, operations and transfer.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
