CREATE CUSTOM
Create a new EyeLevel chat flow that will be associated with the customer API key
post
https://api.eyelevel.ai/v1/partner
/flow/:apiKey
CREATE CUSTOM

Request

{
"flow": {
"connections": [
{ CONNECTION OBJECT }
],
"name": "STRING",
"platform": "ENUMERATED STRING",
"platformId": "STRING IDENTIFIER",
"steps: [
{ STEP OBJECT }
],
"hoursId": INTEGER,
"themeId": INTEGER,
"qrThemeId": INTEGER
}
}

connections

OPTIONAL - Array of CONNECTION objects
An array of CONNECTION objects, containing information about how steps are connected to each other in the flow. If the flow contains more than one STEP, connections is a required parameter. Connections are described in greater detail here.

name

REQUIRED - String
Validation: 300 character limit
The human readable name for the flow.

platform

OPTIONAL - String
Validation: Value is one of the pre-defined enumerated values
The marketing channel where the chat flow will be published. The value must be one of:
  • qr - for QR codes
  • web - for websites
  • linkedin - for LinkedIn ads
  • instagram - for Instagram web ads
  • email - for email marketing
  • gads - for Google search ads
  • fbads - for Facebook web ads
  • facebook - for Facebook platform Messenger ads (includes Instagram)
  • youtube - for YouTube ads
  • fbpage - for Facebook Pages
The different marketing channels are described in greater detail here.

platformId

OPTIONAL - String
Validation: Value is an existing EyeLevel platform identifier Required if platform is included in the request
The unique EyeLevel identifier for where the chat will be hosted. If platform is included in the request, a platformId is a required parameter. You can query for valid platform identifiers of integratiosn you have created using the GET ALL INTEGRATIONS or GET ALL (WEBSITE) query.

steps

REQUIRED - Array of STEP objects
An array of STEP objects, containing information about each step in the flow. The definition of steps are described in greater detail here.

Response

{
"flow": {
"connections": [
{ CONNECTION OBJECT }
],
"id": "STRING IDENTIFIER",
"name": "STRING",
"platform": "ENUMERATED STRING",
"platformId": "STRING IDENTIFIER",
"steps: [
{ STEP OBJECT }
],
"versionId": "STRING IDENTIFIER",
"hoursId": INTEGER,
"themeId": INTEGER,
"qrThemeId": INTEGER
}
}

id

The unique identifier for the flow that was created with the request. You can use this id in other flow API requests.

versionId

The unique identifier for the current version of the flow. If you update the flow using the id, you will create a new version of the flow with the same id but a different versionId.

hoursId

The unique integer identifier for the off hours setting applied to the flow.

themeId

The unique integer identifier for the theme applied to the flow.

qrThemeId

The unique integer identifier for the QR theme applied to the flow.

Objects

Copy link
On this page
post
CREATE CUSTOM
Request
connections
name
platform
platformId
steps
Response
id
versionId
hoursId
themeId
qrThemeId
Objects