Create A Flow

Create a Flow

POST/v2/flows

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Create A Flow action (under Flows).
Fill in the fields below, then reference the result from later steps as {{createAFlow.response.data}}.

Fields

baseUrlstring

The API host this action calls. Choose one, or pick Custom to enter your own.

One ofhttps://euwest.api.elasticpath.comhttps://useast.api.elasticpath.com__custom__Default "https://euwest.api.elasticpath.com"

baseUrlCustomstring

bodystring

The request body content (for POST, PUT, PATCH requests).

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Response

Returns 201 with an object. Read it in later steps with {{createAFlow.response.data.<field>}}.

dataobject

idstring (uuid)

A unique identifier for a resource.

typestring

A unique identifier for a flow/template.

namestring

The name of a flow/template.

slugstring

A unique identifier of a flow/template.

descriptionstring

A short description for a flow/template.

enabledboolean

linksobject1 fields

Link to the current resource.

relationshipsobject1 fields

Relationships are established between different flows/templates entities. For example, a field and an entry are related to a flow as both are attached to it.

metaobject2 fields

json

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "flow",
    "name": "Products",
    "slug": "products",
    "description": "Extends the default product object",
    "enabled": true,
    "links": {
      "self": "https://euwest.api.elasticpath.com/v2/flows/d2a9b22a-b4b0-456b-bbc7-d8723aaffa84"
    },
    "relationships": {
      "fields": {
        "data": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "brand"
          }
        ]
      }
    },
    "meta": {
      "owner": "enum",
      "timestamps": {
        "created_at": "2023-10-11T13:02:25.293Z",
        "updated_at": "2023-10-11T13:02:25.293Z"
      }
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?