Skip to content
HeyCrustDocs

Search documentation

Search by topic or tool name
Partner portalOpen app ↗
Browse documentation
Tool reference

set_flow_status

Returns the saved status or a gating/scope-review/validation error..

Verified ·Read Markdown
On this page

Purpose

Activate (live), pause, or archive a flow. Going live emails/pings real merchants — get the user's explicit OK first and show them the flow summary. Free plan runs 1 live flow (the tool says so if blocked). backfillDays (0-30) also enters merchants whose trigger happened in the last N days; default 0.

Credentials and scope

Owner workspace credential. The credential determines tool visibility. For tools with appId, use the HeyCrust app UUID from list_apps; the dashboard app selector does not supply MCP arguments for you.

Inputs

  • flowId: required; string; format: uuid — Flow id from list_flows.
  • status: required; string; values: live, paused, archived
  • backfillDays: optional; integer; minimum: 0; maximum: 30
  • reviewedVersion: optional; integer; minimum: 1; maximum: 9007199254740991

Example request

The identifiers and merchant are fictional. Replace them with records returned for your own workspace; this example is schema-checked, not a promise that the fictional record exists.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "set_flow_status",
    "arguments": {
      "flowId": "11111111-1111-4111-8111-111111111111",
      "status": "paused",
      "backfillDays": 0
    }
  }
}

POST this JSON to https://heycrust.com/api/mcp with Content-Type: application/json and Authorization: Bearer <YOUR_CREDENTIAL>. The tool result normally contains JSON encoded as text in result.content; inspect JSON-RPC errors and result.isError before using it.

Result

Returns the saved status or a gating/scope-review/validation error.

Effects and verification

Changes status. Activating live can enter merchants and reach real recipients; confirm the summary and any backfill first. The example pauses instead. A required scope review must use the current reviewedVersion returned by get_flow; stale review acknowledgements are rejected.

Troubleshooting

A missing tool can mean that the credential lacks its catalog or required scopes. Invalid arguments are different from unavailable source data or a record outside the workspace. A handler can return a business error even when the argument schema is valid. Read MCP overview and Help.

Continue reading