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.
Data used to create the action
Defines general informations of the action
Defines general settings of the email action
Defines the priority of the email action. Set this property to "true" for high priority, which will utilize a dedicated queue. Set to "false" otherwise.
Defines the importance of the action. Set this property to "true" to mark the email as "important" and display an exclamation point in supported webmail clients. Set to "false" otherwise.
curl -i -X POST \
https://api-cm.np6.com/actions \
-H 'Content-Type: application/json' \
-H 'X-Key: string' \
-d '{
"type": "mailMessage",
"id": "string",
"name": "string",
"description": "string",
"creationDate": "2019-08-24T14:15:22Z",
"informations": {
"folder": 0,
"category": 0,
"state": 10
},
"settings": {
"templating": {
"version": "string"
},
"editionMode": 0,
"purpose": {
"type": "string"
},
"consent": 0,
"priority": true,
"importance": true,
"environment": {},
"field": 0,
"culture": "string",
"contentFormat": 1,
"useFormLinkSSL": true,
"sendingProfile": 0,
"performance": {
"openingRate": 0.1,
"clickRate": 0.1,
"unsubscribedRate": 0.1
},
"mp": {
"use": true,
"increment": true
},
"webAnalyser": 0,
"archive": true
},
"content": {
"headers": {
"from": {
"prefix": "string",
"domain": "string",
"label": "string"
},
"reply": "string"
},
"subject": "string",
"html": "string",
"text": "string"
}
}'The created action
Defines general informations of the action
Defines general settings of the email action
Defines the priority of the email action. Set this property to "true" for high priority, which will utilize a dedicated queue. Set to "false" otherwise.
Defines the importance of the action. Set this property to "true" to mark the email as "important" and display an exclamation point in supported webmail clients. Set to "false" otherwise.
{ "type": "mailMessage", "id": "string", "name": "string", "description": "string", "creationDate": "2019-08-24T14:15:22Z", "informations": { "folder": 0, "category": 0, "state": 10 }, "settings": { "templating": { "version": "string" }, "editionMode": 0, "purpose": { "type": "string" }, "consent": 0, "priority": true, "importance": true, "environment": {}, "field": 0, "culture": "string", "contentFormat": 1, "useFormLinkSSL": true, "sendingProfile": 0, "performance": { "openingRate": 0.1, "clickRate": 0.1, "unsubscribedRate": 0.1 }, "mp": { "use": true, "increment": true }, "webAnalyser": 0, "archive": true }, "content": { "headers": { "from": { "prefix": "string", "domain": "string", "label": "string" }, "reply": "string" }, "subject": "string", "html": "string", "text": "string" } }
curl -i -X POST \
'https://api-cm.np6.com/actions/{id}/duplication?folder=0&type=0' \
-H 'X-Key: string'created action
Defines general informations of the action
Defines general settings of the email action
Defines the priority of the email action. Set this property to "true" for high priority, which will utilize a dedicated queue. Set to "false" otherwise.
Defines the importance of the action. Set this property to "true" to mark the email as "important" and display an exclamation point in supported webmail clients. Set to "false" otherwise.
{ "type": "mailMessage", "id": "string", "name": "string", "description": "string", "creationDate": "2019-08-24T14:15:22Z", "informations": { "folder": 0, "category": 0, "state": 10 }, "settings": { "templating": { "version": "string" }, "editionMode": 0, "purpose": { "type": "string" }, "consent": 0, "priority": true, "importance": true, "environment": {}, "field": 0, "culture": "string", "contentFormat": 1, "useFormLinkSSL": true, "sendingProfile": 0, "performance": { "openingRate": 0.1, "clickRate": 0.1, "unsubscribedRate": 0.1 }, "mp": { "use": true, "increment": true }, "webAnalyser": 0, "archive": true }, "content": { "headers": { "from": { "prefix": "string", "domain": "string", "label": "string" }, "reply": "string" }, "subject": "string", "html": "string", "text": "string" } }
Data used to validate the action or to launch the test phase of the action
Defines the use of the campaign analyser - the feature needs to be activated for the account
curl -i -X POST \
'https://api-cm.np6.com/actions/{id}/validation' \
-H 'Content-Type: application/json' \
-H 'X-Key: string' \
-d '{
"fortest": true,
"campaignAnalyser": true,
"testSegments": [
0
],
"mediaForTest": "string",
"textandHtml": true,
"comments": "string",
"variables": [
{}
]
}'