Notification
/
Execute the specified notification

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

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"
    }
  ]
}

Execute the specified notification

Request

Path
idinteger(int32)required

The notification's id to execute

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

recipientobject

Defines the recipient identification

typestring
Discriminator
valueobject

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

redirectionobject

Defines the overriden default redirection

typestring
Discriminator
channelobject

Defines the overriden underlying channel used to display the notification

typestring
Discriminator
stampobject

Defines stamp informations used to track conversation flow

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

urgentboolean

Defines the priority of this notification execution

curl -i -X POST \
  'https://api-cm.np6.com/notifications/{id}/execution' \
  -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": [
      {}
    ],
    "redirection": {
      "type": "string"
    },
    "channel": {
      "type": "string"
    },
    "stamp": {
      "time": 0,
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "thread": "4e557e2e-a322-4083-8cda-d0357ed0cb0c",
      "set": "6218c222-bd9f-4d43-9cbb-d1adfe7e63bd"
    },
    "urgent": true
  }'

Responses

An execution result

Bodyapplication/json
typestring
Discriminator
idstring(uuid)

Underlying stamp id

recipientobject

Defines the recipient identification

typestring
Discriminator
valueobject

Defines the identifiable contact used as recipient

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

Execute the specified notification

Request

Path
idinteger(int32)required

The notification's id to execute

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

A list of data used to execute the notification

Array [
recipientobject

Defines the recipient identification

typestring
Discriminator
valueobject

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

redirectionobject

Defines the overriden default redirection

typestring
Discriminator
channelobject

Defines the overriden underlying channel used to display the notification

typestring
Discriminator
stampobject

Defines stamp informations used to track conversation flow

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

urgentboolean

Defines the priority of this notification execution

]
curl -i -X POST \
  'https://api-cm.np6.com/notifications/{id}/executions' \
  -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": [
        {}
      ],
      "redirection": {
        "type": "string"
      },
      "channel": {
        "type": "string"
      },
      "stamp": {
        "time": 0,
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "thread": "4e557e2e-a322-4083-8cda-d0357ed0cb0c",
        "set": "6218c222-bd9f-4d43-9cbb-d1adfe7e63bd"
      },
      "urgent": true
    }
  ]'

Responses

A list of execution result

Bodyapplication/jsonArray [
typestring
Discriminator
idstring(uuid)

Underlying stamp id

recipientobject

Defines the recipient identification

typestring
Discriminator
valueobject

Defines the identifiable contact used as recipient

]
Response
application/json
[
  {
    "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.