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

Retrieve all archives of the account

Request

Query
startDatestring or null(date-time)
endDatestring or null(date-time)
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/actions/archives?endDate=2019-08-24T14%3A15%3A22Z&startDate=2019-08-24T14%3A15%3A22Z' \
  -H 'X-Key: string'

Responses

A list of all the archives

Bodyapplication/vnd.np6.cm.mail.archiveArray [
idstring

The id of the archive

actionstring

The id of the action that generated this archive

targetstring

The id of the target that received this mail

sendingDatestring(date-time)

The date at which the target received the mail

urlstring

The url at which you can retrieve the archive

expiresOnstring(date-time)

The date at which the url will expire

]
Response
application/vnd.np6.cm.mail.archive
[
  {
    "id": "0bdecb51-8e51-4a2c-8a82-6fe516d0a8f9",
    "action": "00000A",
    "target": "000T123",
    "sendingDate": "2025-04-01T12:40:39.207Z",
    "url": "    ",
    "expiresOn": "2025-05-03T12:40:39.207Z"
  },
  {
    "id": "4a114792-33fd-4512-9799-c6287365e650",
    "action": "00000B",
    "target": "000T124",
    "sendingDate": "2025-04-01T12:40:39.209Z",
    "url": "https://mcom032.blob.core.windows.net/mcom032/4f54ed5e-f0f3-4a3a-9ce9-23b499e7e844.eml?sv=2020-02-10&st=2024-04-03T15%3A12%3A02Z&se=2024-05-05T15%3A12%3A02Z&sr=b&sp=r&sig=hnGaHP7EM8sml4WJtidaYKSr4SsRNQ8gDRtrazRFrRE%3D",
    "expiresOn": "2025-05-03T12:40:39.209Z"
  }
]

Retrieve all archives of the action

Request

Path
idstringrequired

Id of the specified action

Query
startDatestring or null(date-time)
endDatestring or null(date-time)
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/actions/{id}/archives?endDate=2019-08-24T14%3A15%3A22Z&startDate=2019-08-24T14%3A15%3A22Z' \
  -H 'X-Key: string'

Responses

A list of all the archives of the action

Bodyapplication/vnd.np6.cm.mail.archiveArray [
idstring

The id of the archive

actionstring

The id of the action that generated this archive

targetstring

The id of the target that received this mail

sendingDatestring(date-time)

The date at which the target received the mail

urlstring

The url at which you can retrieve the archive

expiresOnstring(date-time)

The date at which the url will expire

]
Response
application/vnd.np6.cm.mail.archive
[
  {
    "id": "b510c173-9137-4037-8413-8cc2ca47f16e",
    "action": "00000A",
    "target": "000T123",
    "sendingDate": "2025-04-01T12:40:39.266Z",
    "url": "https://mcom032.blob.core.windows.net/mcom032/4f54ed5e-f0f3-4a3a-9ce9-23b499e7e844.eml?sv=2020-02-10&st=2024-04-03T15%3A12%3A02Z&se=2024-05-05T15%3A12%3A02Z&sr=b&sp=r&sig=hnGaHP7EM8sml4WJtidaYKSr4SsRNQ8gDRtrazRFrRE%3D",
    "expiresOn": "2025-05-03T12:40:39.266Z"
  },
  {
    "id": "ccc0e3e8-a474-4919-9cec-f212d8bee248",
    "action": "00000A",
    "target": "000T124",
    "sendingDate": "2025-04-01T12:40:39.266Z",
    "url": "https://mcom032.blob.core.windows.net/mcom032/4f54ed5e-f0f3-4a3a-9ce9-23b499e7e844.eml?sv=2020-02-10&st=2024-04-03T15%3A12%3A02Z&se=2024-05-05T15%3A12%3A02Z&sr=b&sp=r&sig=hnGaHP7EM8sml4WJtidaYKSr4SsRNQ8gDRtrazRFrRE%3D",
    "expiresOn": "2025-05-03T12:40:39.266Z"
  }
]

Retrieve all archives of the action sent to that target

Request

Path
idstringrequired

Id of the specified action

targetstringrequired

Id of the specified target

Query
startDatestring or null(date-time)
endDatestring or null(date-time)
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/actions/{id}/targets/{target}/archives?endDate=2019-08-24T14%3A15%3A22Z&startDate=2019-08-24T14%3A15%3A22Z' \
  -H 'X-Key: string'

Responses

A list of all the archives of the action and target

Bodyapplication/vnd.np6.cm.mail.archiveArray [
idstring

The id of the archive

actionstring

The id of the action that generated this archive

targetstring

The id of the target that received this mail

sendingDatestring(date-time)

The date at which the target received the mail

urlstring

The url at which you can retrieve the archive

expiresOnstring(date-time)

The date at which the url will expire

]
Response
application/vnd.np6.cm.mail.archive
[
  {
    "id": "f980f445-4e13-455e-ae92-35e6754d8d74",
    "action": "00000A",
    "target": "000T123",
    "sendingDate": "2025-04-01T12:40:39.273Z",
    "url": "https://mcom032.blob.core.windows.net/mcom032/4f54ed5e-f0f3-4a3a-9ce9-23b499e7e844.eml?sv=2020-02-10&st=2024-04-03T15%3A12%3A02Z&se=2024-05-05T15%3A12%3A02Z&sr=b&sp=r&sig=hnGaHP7EM8sml4WJtidaYKSr4SsRNQ8gDRtrazRFrRE%3D",
    "expiresOn": "2025-05-03T12:40:39.273Z"
  },
  {
    "id": "0aaade59-d3b2-477c-8e74-8c712d2c75d3",
    "action": "00000A",
    "target": "000T123",
    "sendingDate": "2025-03-30T12:40:39.273Z",
    "url": "https://mcom032.blob.core.windows.net/mcom032/4f54ed5e-f0f3-4a3a-9ce9-23b499e7e844.eml?sv=2020-02-10&st=2024-04-03T15%3A12%3A02Z&se=2024-05-05T15%3A12%3A02Z&sr=b&sp=r&sig=hnGaHP7EM8sml4WJtidaYKSr4SsRNQ8gDRtrazRFrRE%3D",
    "expiresOn": "2025-05-01T12:40:39.273Z"
  }
]

Email & SMS

Operations

Notification

Operations

Display

Operations

Email & SMS

Operations

Notification

Operations

Workflow

Operations

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