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.
- Duplicate an action
Retrieve the specified action
Update an action
Delete an action
Create an action
Test or validate an action
Unvalidate an action
Render multiple messages
Render a message
Send messages
Send message
Retrieve all actions
Export a list of all recipients of an action
Export a list of recipients who have opened an action
Export a list of recipients who have clicked a link on receipt of an action
Render links
Send a message
Duplicate an action
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
Bodyapplication/json
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.
- Production serverhttps://api-cm.np6.com/actions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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.
Response
application/json
{ "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" } }
- Production serverhttps://api-cm.np6.com/actions/{id}/duplication
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-cm.np6.com/actions/{id}/duplication?type=0&folder=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.
Response
application/json
{ "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" } }
Bodyapplication/json
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
- Production serverhttps://api-cm.np6.com/actions/{id}/validation
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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": [
{}
]
}'