Skip to main content
POST
/
v2.0
/
flows
/
{flowId}
/
chart
/
nodes
Create a new ChartNode
curl --request POST \
  --url 'https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart/nodes?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data @- <<EOF
{
  "type": "if",
  "target": "63c6c16a7e1ef09c81f6075d",
  "mode": "append",
  "extension": "@cognigy/basic-nodes",
  "label": "A new Node",
  "comment": "this is a very important node",
  "commentColor": "#ff8a80",
  "isEntryPoint": false,
  "isDisabled": false,
  "config": {
    "condition": {
      "type": "rule",
      "condition": "",
      "rule": {
        "left": "1",
        "operand": "gt",
        "right": "2"
      }
    }
  },
  "localeReference": "63bd8ebb648e6e739f1bbd82",
  "analyticsLabel": "condition",
  "mock": {
    "isEnabled": false,
    "code": "console.log('Hello, world!');"
  },
  "position": 42
}
EOF
{
  "type": "if",
  "extension": "@cognigy/basic-nodes",
  "label": "A new Node",
  "comment": "this is a very important node",
  "commentColor": "#ff8a80",
  "isEntryPoint": false,
  "isDisabled": false,
  "config": {
    "condition": {
      "type": "rule",
      "condition": "",
      "rule": {
        "left": "1",
        "operand": "gt",
        "right": "2"
      }
    }
  },
  "localeReference": "63bd8ebb648e6e739f1bbd82",
  "analyticsLabel": "condition",
  "mock": {
    "isEnabled": false,
    "code": "console.log('Hello, world!');"
  },
  "_id": "<string>"
}

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

ā€‹
api_key
string
query
required

Supply the API Key in the Url-Query

ā€‹
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

ā€‹
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

ā€‹
flowId
string
required

The Id of the Flow

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Body

application/json
ā€‹
type
string
required

Type of the Node

Example:

"if"

ā€‹
target
string
required

The ID of the previous or parent node to which the current node should be attached.

Example:

"63c6c16a7e1ef09c81f6075d"

ā€‹
mode
enum<string>
required
Available options:
append,
prepend,
appendChild,
prependChild,
insertChildAt,
insertAfter,
insertBefore
ā€‹
extension
string
Example:

"@cognigy/basic-nodes"

ā€‹
label
string

Replaces the default name of the Node displayed in the Flow Editor.

Example:

"A new Node"

ā€‹
comment
string

Adds additional information about Nodes, for example, a specific of the Node.

Example:

"this is a very important node"

ā€‹
commentColor
Pattern: ^#(?:[0-9a-fA-F]{3}){1,2}$
Example:

"#ff8a80"

ā€‹
isEntryPoint
boolean
Example:

false

ā€‹
isDisabled
boolean
Example:

false

ā€‹
config
object
Example:
{
  "condition": {
    "type": "rule",
    "condition": "",
    "rule": {
      "left": "1",
      "operand": "gt",
      "right": "2"
    }
  }
}
ā€‹
localeReference
string
Example:

"63bd8ebb648e6e739f1bbd82"

ā€‹
analyticsLabel
string
Example:

"condition"

ā€‹
mock
object
ā€‹
position
number

The desired position. Only used for insertChildAt.

Required range: 0 <= x <= 2147483647
Example:

42

Response

Returns ChartNode metadata object.

ā€‹
type
string

Type of the Node

Example:

"if"

ā€‹
extension
string
Example:

"@cognigy/basic-nodes"

ā€‹
label
string

Replaces the default name of the Node displayed in the Flow Editor.

Example:

"A new Node"

ā€‹
comment
string

Adds additional information about Nodes, for example, a specific of the Node.

Example:

"this is a very important node"

ā€‹
commentColor
Pattern: ^#(?:[0-9a-fA-F]{3}){1,2}$
Example:

"#ff8a80"

ā€‹
isEntryPoint
boolean
Example:

false

ā€‹
isDisabled
boolean
Example:

false

ā€‹
config
object
Example:
{
  "condition": {
    "type": "rule",
    "condition": "",
    "rule": {
      "left": "1",
      "operand": "gt",
      "right": "2"
    }
  }
}
ā€‹
localeReference
string
Example:

"63bd8ebb648e6e739f1bbd82"

ā€‹
analyticsLabel
string
Example:

"condition"

ā€‹
mock
object
ā€‹
_id
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$