POST
/
v1
/
flows
curl --request POST \
  --url https://cloud.activepieces.com/api/v1/flows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "displayName": "<string>",
  "folderId": "<string>",
  "folderName": "<string>",
  "projectId": "<string>",
  "metadata": {}
}'
{
  "id": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "projectId": "<string>",
  "externalId": "<string>",
  "folderId": "<string>",
  "status": "ENABLED",
  "schedule": {
    "type": "CRON_EXPRESSION",
    "cronExpression": "<string>",
    "timezone": "<string>",
    "failureCount": 123
  },
  "publishedVersionId": "<string>",
  "metadata": {},
  "version": {
    "id": "<string>",
    "created": "<string>",
    "updated": "<string>",
    "flowId": "<string>",
    "displayName": "<string>",
    "trigger": {
      "name": "<string>",
      "valid": true,
      "displayName": "<string>",
      "nextAction": "<any>",
      "type": "PIECE_TRIGGER",
      "settings": {
        "pieceName": "<string>",
        "pieceVersion": "<string>",
        "pieceType": "CUSTOM",
        "packageType": "ARCHIVE",
        "triggerName": "<string>",
        "input": {},
        "inputUiInfo": {
          "sampleDataFileId": "<string>",
          "sampleDataInputFileId": "<string>",
          "lastTestDate": "<string>",
          "customizedInputs": {},
          "schema": {},
          "currentSelectedData": "<any>"
        }
      }
    },
    "updatedBy": "<string>",
    "valid": true,
    "schemaVersion": "<string>",
    "state": "LOCKED"
  }
}

Authorizations

​
Authorization
string
header
required

Use your api key generated from the admin console

Body

application/json
​
displayName
string
required
​
projectId
string
required
​
folderId
string
​
folderName
string
​
metadata
object

Response

201 - application/json
Default Response
​
id
string
required
​
created
string
required
​
updated
string
required
​
projectId
string
required
​
status
required
Available options:
ENABLED
​
version
object
required
​
externalId
string | null
​
folderId
string | null
​
schedule
object | null
​
publishedVersionId
string | null
​
metadata
object | null