Skip to content
/
Test the "master" version...

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

Email & SMS

Operations

Notification

Operations

Render the specified version of the specified notification and the specified contact hash

Request

Path
idinteger(int32)required

The notification's id to execute

versionstring(uuid)required

The notification's version to render

Query
hashstringrequired

The contact hash used to render the notification

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/notifications/{id}/versions/{version}/render/contact?hash=string' \
  -H 'X-Key: string'

Responses

A render result

Bodyapplication/json
typestring
Discriminator
metaobject

Meta informations

notificationinteger(int32)

Defines the notification id used to render

versionstring(uuid)

Defines the notification version used to render

applicationstring(uuid)

Defines the application id used to render

subscriptionstring(uuid)

Defines the subscription id used to render

stampobject

Defines the stamp used to render

channelstring

Defines the underlying rendered channel result

redirectionstring

Defines the underlying rendered redirection link result

renderobject

Render values

titlestring

Defines the "title" rendered value of the notification

bodystring

Defines the "body" rendered value of the notification

iconstring

Defines the "icon" rendered value of the notification

thumbnailstring

Defines the "thumbnail" rendered value of the notification

imagestring

Defines the "image" rendered value of the notification

trackingobject

Tracking values

radicalstring

Defines the "radical" tracking base uri of the notification

impressionstring

Defines the "impression" tracking information of the notification

redirectionstring

Defines the "redirection" tracking information of the notification

dismissstring

Defines the "dismiss" tracking information of the notification

optoutobject

Defines "optout" tracking informations of the notification

Response
application/json
{
  "type": "success",
  "meta": {
    "notification": 0,
    "version": "8b898373-21c7-4028-b85f-cc5068e68df9",
    "application": "2b22d485-f04e-492b-b364-e14f8506726a",
    "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8",
    "stamp": {
      "time": 0,
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "thread": "4e557e2e-a322-4083-8cda-d0357ed0cb0c",
      "set": "6218c222-bd9f-4d43-9cbb-d1adfe7e63bd"
    },
    "channel": "string",
    "redirection": "string"
  },
  "render": {
    "title": "string",
    "body": "string",
    "icon": "string",
    "thumbnail": "string",
    "image": "string"
  },
  "tracking": {
    "radical": "string",
    "impression": "string",
    "redirection": "string",
    "dismiss": "string",
    "optout": {
      "global": "string",
      "channel": "string"
    }
  }
}

Test the "master" version of the specified notification

Request

Path
idinteger(int32)required

The notification's id to test

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/json

Data used to test the notification

recipientobject

Defines the recipient

typestring
Discriminator
valueinteger(int32)

Defines the identifiable contact used as recipient

titlestring

Defines the title override of the notifcation's content

bodystring

Defines the body override of the notifcation's content

iconstring

Defines the icon override of the notifcation's content

thumbnailstring

Defines the thumbnail override of the notifcation's content

imagestring

Defines the image override of the notifcation's content

dataobject

Defines data used to render views

variablesArray of objects

Defines variables used to render views

expirationobject

Defines the overriden expiration

typestring
Discriminator
valueobject
redirectionobject

Defines the overriden default redirection

typestring
Discriminator
channelobject

Defines the overriden underlying channel used to display the notification

typestring
Discriminator
curl -i -X POST \
  'https://api-cm.np6.com/notifications/{id}/test' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "recipient": {
      "type": "string"
    },
    "title": "string",
    "body": "string",
    "icon": "string",
    "thumbnail": "string",
    "image": "string",
    "data": {},
    "variables": [
      {}
    ],
    "expiration": {
      "type": "string"
    },
    "redirection": {
      "type": "string"
    },
    "channel": {
      "type": "string"
    }
  }'

Responses

A test result

Bodyapplication/json
typestring
Discriminator
idstring(uuid)

Defines the underlying test id

resultsArray of objects

Defines the underlying test results

typestring
Discriminator
idstring(uuid)

Uuid of the event

timestampinteger(int64)

Publication timestamp of the event
This is the number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.

identityobject

Underlying identity of the event

sourceobject

Source of the event

Response
application/json
{
  "type": "success",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "results": [
    {
      "type": "string"
    }
  ]
}

Test the specified version of the specified notification

Request

Path
idinteger(int32)required

The notification's id to test

versionstring(uuid)required

The notification's version to test

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/json

Data used to test the notification

recipientobject

Defines the recipient

typestring
Discriminator
valueinteger(int32)

Defines the identifiable contact used as recipient

titlestring

Defines the title override of the notifcation's content

bodystring

Defines the body override of the notifcation's content

iconstring

Defines the icon override of the notifcation's content

thumbnailstring

Defines the thumbnail override of the notifcation's content

imagestring

Defines the image override of the notifcation's content

dataobject

Defines data used to render views

variablesArray of objects

Defines variables used to render views

expirationobject

Defines the overriden expiration

typestring
Discriminator
valueobject
redirectionobject

Defines the overriden default redirection

typestring
Discriminator
channelobject

Defines the overriden underlying channel used to display the notification

typestring
Discriminator
curl -i -X POST \
  'https://api-cm.np6.com/notifications/{id}/versions/{version}/test' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "recipient": {
      "type": "string"
    },
    "title": "string",
    "body": "string",
    "icon": "string",
    "thumbnail": "string",
    "image": "string",
    "data": {},
    "variables": [
      {}
    ],
    "expiration": {
      "type": "string"
    },
    "redirection": {
      "type": "string"
    },
    "channel": {
      "type": "string"
    }
  }'

Responses

A test result

Bodyapplication/json
typestring
Discriminator
idstring(uuid)

Defines the underlying test id

resultsArray of objects

Defines the underlying test results

typestring
Discriminator
idstring(uuid)

Uuid of the event

timestampinteger(int64)

Publication timestamp of the event
This is the number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.

identityobject

Underlying identity of the event

sourceobject

Source of the event

Response
application/json
{
  "type": "success",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "results": [
    {
      "type": "string"
    }
  ]
}

Archives

Operations

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
© 2025 - ChapsVision - All Rights Reserved.