Update Flow Status
PATCH {{baseUrl}}/api/flows/:id/
Update the status of a flow with the given flow ID, and all actions in that flow.
Rate limits:
Burst: 3/s
Steady: 60/m
Scopes:
flows:write
Request Body
{"data"=>{"type"=>"flow", "id"=>"<string>", "attributes"=>{"status"=>"<string>"}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":{"type":"flow","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","status":"\u003cstring\u003e","archived":"\u003cboolean\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","trigger_type":"Metric"},"links":{"self":"\u003curi\u003e"},"relationships":{"flow-actions":{"data":[{"type":"flow-action","id":"\u003cstring\u003e"},{"type":"flow-action","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"tags":{"data":[{"type":"tag","id":"\u003cstring\u003e"},{"type":"tag","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}}