Switch an agent automation on or off

toggle_agent_automation

Switches one agent automation on a site on or off.

POST /v1/toggle_agent_automationScopeconfig:writeMakes changes

Switching it on recomputes its next run from now, and clears its failure count and any reason it was switched off. It is refused while the site is locked, when its schedule is closer together than 5 minutes, and when the person who set it up left the workspace or no longer has an active account. Switching it off keeps its instruction and its run history, and always works, even on a locked site. When Modulify switched an automation off, only Modulify can switch it back on. See Agents.

Request

Call it with a POST to https://api.modulify.ai/v1/toggle_agent_automation, sending the inputs below as a JSON object. The token needs the config:write scope.

It makes changes, so send an Idempotency-Key header whenever you might retry it. A retry with the same key gets the first answer back instead of running again.

curl -X POST https://api.modulify.ai/v1/toggle_agent_automation \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"PROJECT_ID","automationId":"AUTOMATION_ID","enabled":true}'

Over MCP, the same method is the toggle_agent_automation tool.

Inputs

Input Type Required Description
projectId string Yes The site id.
automationId string Yes The automation id from list_agent_automations.
enabled boolean Yes true to switch it on, false to switch it off.

Response

Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.