The action's id to render
- Render a message
Retrieve the specified action
Update an action
Delete an action
Create an action
Duplicate an action
Test or validate an action
Unvalidate an action
Render multiple messages
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
Render a message
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
Body
- application/vnd.np6.cm.email
- application/vnd.np6.cm.sms
A list of render definitions
The receiver identification
The related identification
Stamp data
Headers overrides
Content override
Views overrides
- Production serverhttps://api-cm.np6.com/actions/{id}/renders
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-cm.np6.com/actions/{id}/renders' \
-H 'Content-Type: application/vnd.np6.cm.email' \
-H 'X-Key: string' \
-d '[object Object]'Response
application/json
[ { "type": "string" } ]
Body
- application/vnd.np6.cm.email
- application/vnd.np6.cm.sms
A render definition
The receiver identification
The related identification
Stamp data
Headers overrides
Content override
- Production serverhttps://api-cm.np6.com/actions/{id}/render
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-cm.np6.com/actions/{id}/render' \
-H 'Content-Type: application/vnd.np6.cm.email' \
-H 'X-Key: string' \
-d '[object Object]'Response
application/json
{ "type": "success", "recipient": "string", "sender": { "bounce": "string", "label": "string", "reply": "string", "value": "string" }, "subject": "string", "html": "string", "text": "string", "amp": "string", "headers": { "property1": "string", "property2": "string" } }
Body
- application/vnd.np6.cm.email
- application/vnd.np6.cm.sms
A list of message definitions
The recipient identification
The related identification
Carbon copies
Template "headers"
Attachments
Views overrides
Stamp data
- Production serverhttps://api-cm.np6.com/actions/{id}/executions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-cm.np6.com/actions/{id}/executions' \
-H 'Content-Type: application/vnd.np6.cm.email' \
-H 'X-Key: string' \
-d '[object Object],[object Object]'Response
application/json
[ { "type": "success", "id": "497a760d-e444-484f-b964-125cf548bb9c", "recipient": { "type": "footprint", "id": "00000001", "unicity": "unicity_1", "hash": "409ba38aa13699d31caa8b42c94a5dc8" } }, { "type": "success", "id": "804b1456-1280-4744-b556-29a36031b44f", "recipient": { "type": "footprint", "id": "00000002", "unicity": "unicity_2", "hash": "2f5c786adbb6ca1fb4e2226104b0fbc7" } } ]