Skip to navigation

Save flow as template

Saves the flow's current definition as a template private to this account.

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

flowIdstringRequiredformat: "uuid"
Flow ID

Request

This endpoint expects an object.
categorystringRequired
Template category
namestringRequired
Template name
descriptionstring or nullOptional
Brief description of the template
iconstring or nullOptional
Icon identifier or emoji for display
tagslist of stringsOptional
Searchable tags for the template

Response

Flow saved as template
categorystring
Template category for filtering
createdAtdatetime
When the template was created
displayOrderinteger

Sort order for template listing (lower = first)

edgesobject
Flow edge connections between nodes
idstringformat: "uuid"
Unique template identifier
initialNodestring
ID of the first node to execute
isActiveboolean
Whether this template is available for use
namestring
Template display name
nodesobject
Flow node definitions
slugstring

URL-safe slug for the template

updatedAtdatetime
When the template was last modified
accountIdstring or nullOptionalformat: "uuid"

Account that owns this template (null for system templates)

createdBystring or nullOptionalformat: "uuid"
User who created this template
definitionobject or nullOptional

Runtime FlowDefinition (initialNode + services + nodes). This is what instantiation copies into the new flow’s definition. Null on legacy templates that only carry builder nodes/edges.

descriptionstring or nullOptional
Brief description of what the template does
iconstring or nullOptional
Icon identifier or emoji for display
previewImageUrlstring or nullOptional
URL to a preview image for the template
tagslist of stringsOptional
Searchable tags

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error