Notification
/
Render the "master" version of the specified notification and the specified contact hash

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

Render the "master" version of the specified notification and the specified contact unicity

Request

Path
idinteger(int32)required

The notification's id to execute

Query
unicitystringrequired

The contact unicity 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}/render/contact?unicity=' \
  -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"
    }
  }
}

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

Request

Path
idinteger(int32)required

The notification's id to execute

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}/render/contact?hash=' \
  -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"
    }
  }
}

Render the specified version of the specified notification

Request

Path
idinteger(int32)required

The notification's id to render

versionstring(uuid)required

The notification's version to render

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 render the notification

receiverobject

The receiver identification

idstring

Identifier of the contact

unicitystring

Unicity of the contact

hashstring

Hash of the contact

creationstring(date-time)

The creation date of the contact

updatestring(date-time)

The last update of the contact

fieldsobject

The field values of the targets

relatedobject

The related identification

idstring

Identifier of the contact

unicitystring

Unicity of the contact

hashstring

Hash of the contact

creationstring(date-time)

The creation date of the contact

updatestring(date-time)

The last update of the contact

fieldsobject

The field values of the targets

stampobject

Stamp informations

timeinteger(int64)

Creation time of the stamp
This is the number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.

idstring(uuid)

The stamp id

threadstring(uuid)

The thread id

setstring(uuid)

The set id

contextobject

The related identification

dataobject

Rendering data

variablesArray of objects

Additionnal variables

displayinteger(int32)

Underlying display configuration

Enum0124816
titlestring

Title override

bodystring

Body override

iconstring

Icon override

thumbnailstring

Thumbnail override

imagestring

Image override

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}/render' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "receiver": {
      "id": "string",
      "unicity": "string",
      "hash": "string",
      "creation": "2019-08-24T14:15:22Z",
      "update": "2019-08-24T14:15:22Z",
      "fields": {}
    },
    "related": {
      "id": "string",
      "unicity": "string",
      "hash": "string",
      "creation": "2019-08-24T14:15:22Z",
      "update": "2019-08-24T14:15:22Z",
      "fields": {}
    },
    "stamp": {
      "time": 0,
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "thread": "4e557e2e-a322-4083-8cda-d0357ed0cb0c",
      "set": "6218c222-bd9f-4d43-9cbb-d1adfe7e63bd"
    },
    "context": {
      "data": {},
      "variables": [
        {}
      ],
      "display": 0
    },
    "title": "string",
    "body": "string",
    "icon": "string",
    "thumbnail": "string",
    "image": "string",
    "redirection": {
      "type": "string"
    },
    "channel": {
      "type": "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"
    }
  }
}

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.