API ReferenceReferenceFlows
Publish a flow
Snapshots the DRAFT as a new version and, unless deployToProduction is false, makes it the live version end users and API callers get. Its questions become the published run parameters. Requires the flows:write scope.
Authorization
apiKey AuthorizationBearer <token>
An organization API key, created from a Portal's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).
In: header
Path Parameters
flowId*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/flows/497f6eca-6276-4993-bfeb-53cbbbba6f08/publish" \ -H "Content-Type: application/json" \ -d '{}'{ "flow": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "agent", "type": "string", "name": "string", "slug": "string", "description": "string", "published": true, "productionVersionId": "a45124a6-f1ae-495a-9d4c-946315091da1", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "version": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "createdAt": "2019-08-24T14:15:22Z", "isProduction": true, "publishedBy": "string", "source": "string", "notes": "string" }}