Create a Flow

Create a new flow.

fieldsstring[]

Control what fields are being returned in the object.

metastring

What metadata to return in the response.

Request body

idstring

Unique identifier for the flow.

namestring

The name of the flow.

iconstring

Icon displayed in the Admin App for the flow.

colorstring nullable

Color of the icon displayed in the Admin App for the flow.

descriptionstring nullable

status'active' | 'inactive'

Current status of the flow.

triggerstring

Type of trigger for the flow. One of hook, webhook, operation, schedule, manual.

accountabilitystring

The permission used during the flow. One of $public, $trigger, $full, or UUID of a role.

optionsobject nullable

Options of the selected trigger for the flow.

date_createdstring date-time nullable

Timestamp in ISO8601 when the flow was created.

Successful request