NP6 API Reference (8.1.0)

This documentation provides comprehensive access to the full range of functionalities offered by the NP6 platform through a standardized RESTful interface.

If you have any questions or need assistance, please contact our support team at https://support.chapsvision.com.

Languages
Servers
Production server
https://api-cm.np6.com/

Good to know

Email & SMS

Operations

Notification

Operations

Archives

Operations

Email & SMS

Operations

Notification

Operations

Display

Operations

Email & SMS

Operations

Notification

Operations

Workflow

Operations

Retrieve nodes of the specified workflow

Request

Path
idinteger(int32)required

The workflow's id to retrieve nodes

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

curl -i -X GET \
  'https://api-cm.np6.com/scripting/workflows/{id}/nodes' \
  -H 'X-Key: string'

Responses

An array of nodes

Bodyapplication/jsonArray [
typestring
Discriminator
idstring

The node's id

namestring

The node's name

descriptionstring

The node's description

defaultboolean

The "entry point" node's capabilites

settingsobject

The node settings

nextstring

The next identifier of the node to execute

eventobject

Name of the event to emit

typestring
Discriminator
valueobject

A literal expression

dataobject

Evaluated data used to emit event

typestring
Discriminator
valueobject

A literal expression

flowobjectDeprecated

The node's control flow

typestring
Discriminator
valuestring

The next identifier of the node

]
Response
application/json
[ { "type": "string" } ]

Update nodes of the specified workflow

Request

Path
idinteger(int32)required

The workflow's id to update nodes

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

Bodyapplication/json

Data used to update nodes of the workflow

Array [
typestring
Discriminator
idstring

The node's id

namestring

The node's name

descriptionstring

The node's description

defaultboolean

The "entry point" node's capabilites

settingsobject

The node settings

nextstring

The next identifier of the node to execute

eventobject

Name of the event to emit

typestring
Discriminator
valueobject

A literal expression

dataobject

Evaluated data used to emit event

typestring
Discriminator
valueobject

A literal expression

flowobjectDeprecated

The node's control flow

typestring
Discriminator
valuestring

The next identifier of the node

]
curl -i -X PUT \
  'https://api-cm.np6.com/scripting/workflows/{id}/nodes' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '[
    {
      "type": "string"
    }
  ]'

Responses

An array of updated nodes

Bodyapplication/jsonArray [
typestring
Discriminator
idstring

The node's id

namestring

The node's name

descriptionstring

The node's description

defaultboolean

The "entry point" node's capabilites

settingsobject

The node settings

nextstring

The next identifier of the node to execute

eventobject

Name of the event to emit

typestring
Discriminator
valueobject

A literal expression

dataobject

Evaluated data used to emit event

typestring
Discriminator
valueobject

A literal expression

flowobjectDeprecated

The node's control flow

typestring
Discriminator
valuestring

The next identifier of the node

]
Response
application/json
[ { "type": "string" } ]

Delete nodes of the specified workflow

Request

Path
idinteger(int32)required

The workflow's id to delete nodes

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

curl -i -X DELETE \
  'https://api-cm.np6.com/scripting/workflows/{id}/nodes' \
  -H 'X-Key: string'

Responses

No Content

Campaign

Operations

Campaign

Operations

Contact

Operations

Field

Operations

Enumeration

Operations

Segment

Operations

Import

Operations

Subscription

Operations

Contact

Operations

Webtask

Operations

Compilable

Operations

Mobile Application

Operations

Category

Operations

Marketing Pressure

Operations