Workflow
/
Execute the specified task of the specified workflow

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

Execute the specified workflow

Request

Path
idinteger(int32)required

The workflow's id to execute

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/vnd.np6.cm.workflow-v4

A list of data used to execute Workflow

Array [
idstring

Underlying execution id

receiverobject

The receiver identification

typestring
Discriminator
valuestring

Id of the target

nodestring

The startup node

eventobject

Underlying workflow event

stateobject

Internal state

dataobject

Underlying data

variablesArray of objects

Additionnal variables

resolutionsArray of objects

Underlying resolution

keystring

Key

valueobject

Value

debugobject

Debugging informations

versionstring
Discriminator
idstring

Underlying id of the debug

ttlinteger(int32)

Represents the maximum number of nodes to execute

nodesArray of objects

A list of debugged nodes

stampobject

Stamp informations

timeinteger(int64)

Creation time of the stamp
This is the number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.

idstring(uuid)

The stamp id

threadstring(uuid)

The thread id

setstring(uuid)

The set id

]
curl -i -X POST \
  'https://api-cm.np6.com/scripting/workflows/{id}/executions' \
  -H 'Content-Type: application/vnd.np6.cm.workflow-v4' \
  -H 'X-Key: string' \
  -d '[object Object]'

Responses

A list of execution result

Bodyapplication/vnd.np6.cm.workflow-v4Array [
typestring
Discriminator
flowobject

A representation of the executed flow

]

Execute the specified task of the specified workflow

Request

Path
idinteger(int32)required

The workflow's id to execute

uuidstringrequired

The task's uuid to execute

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 POST \
  'https://api-cm.np6.com/scripting/workflows/{id}/tasks/{uuid}/execution' \
  -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
© 2025 - ChapsVision - All Rights Reserved.