Skip to content
/
Delete a 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

Email & SMS

Operations

Notification

Operations

Update a notification

Request

Path
idinteger(int32)required

The notification's id to update

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

typestring
Discriminator
idinteger(int32)

Defines the id of the notification

namestring

Defines the name of the notification

descriptionstring

Defines the description of the notification

stampobject

Defines the stamp informations of the notification

creationstring(date-time)

Defines a date, used to store the creation date of a related data

modificationstring(date-time)

Defines a date, used to store the last modification date of a related data

activeboolean

Defines the online state of the notification

settingsobject

Notification settings

urgentboolean

Notification urgency, default : false

categoryinteger or null(int32)

Defines the underlying category of the notification

purposeobject

Notification purpose : Marketing | Service, default : Marketing

expirationobject
mpobject

Holds the marketing pressure settings

applicationstring(uuid)

Defines the underlying notifiable application used to bind subscribers

taskobject

Defines a task used to specify how to trigger the notification

idstring(uuid)

Defines the id of the task

namestring

Defines the name of the task

descriptionstring

Defines the description of the task

schedulerobject

Defines the way to schedule the execution

versionsArray of objects

Defines versions of the notification

idstring(uuid)

Defines the unique id of the version

masterboolean

Defines if the version is considered as the "master" version

labelstring

Defines the label of the version

stampobject

Defines the stamp informations of the version

scriptingobject

Defines the scripting settings of the version

contentobject

Defines the content of the version

redirectionobject

Defines the default redirection

channelobject

Defines the underlying channel used to display the notification

curl -i -X PUT \
  'https://api-cm.np6.com/notifications/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "type": "push-app",
    "id": 0,
    "name": "string",
    "description": "string",
    "stamp": {
      "creation": "2019-08-24T14:15:22Z",
      "modification": "2019-08-24T14:15:22Z"
    },
    "active": true,
    "settings": {
      "urgent": true,
      "category": 0,
      "purpose": {
        "type": "string"
      },
      "expiration": {
        "type": "string"
      },
      "mp": {}
    },
    "application": "2b22d485-f04e-492b-b364-e14f8506726a",
    "task": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "scheduler": {
        "type": "string"
      }
    },
    "versions": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "master": true,
        "label": "string",
        "stamp": {
          "creation": "2019-08-24T14:15:22Z",
          "modification": "2019-08-24T14:15:22Z"
        },
        "scripting": {
          "version": "string"
        },
        "content": {
          "type": "string"
        },
        "redirection": {
          "type": "string"
        },
        "channel": {
          "type": "string"
        }
      }
    ]
  }'

Responses

The updated notification

Bodyapplication/json
typestring
Discriminator
idinteger(int32)

Defines the id of the notification

namestring

Defines the name of the notification

descriptionstring

Defines the description of the notification

stampobject

Defines the stamp informations of the notification

creationstring(date-time)

Defines a date, used to store the creation date of a related data

modificationstring(date-time)

Defines a date, used to store the last modification date of a related data

activeboolean

Defines the online state of the notification

settingsobject

Notification settings

urgentboolean

Notification urgency, default : false

categoryinteger or null(int32)

Defines the underlying category of the notification

purposeobject

Notification purpose : Marketing | Service, default : Marketing

expirationobject
mpobject

Holds the marketing pressure settings

applicationstring(uuid)

Defines the underlying notifiable application used to bind subscribers

taskobject

Defines a task used to specify how to trigger the notification

idstring(uuid)

Defines the id of the task

namestring

Defines the name of the task

descriptionstring

Defines the description of the task

schedulerobject

Defines the way to schedule the execution

versionsArray of objects

Defines versions of the notification

idstring(uuid)

Defines the unique id of the version

masterboolean

Defines if the version is considered as the "master" version

labelstring

Defines the label of the version

stampobject

Defines the stamp informations of the version

scriptingobject

Defines the scripting settings of the version

contentobject

Defines the content of the version

redirectionobject

Defines the default redirection

channelobject

Defines the underlying channel used to display the notification

Response
application/json
{
  "type": "push-app",
  "id": 0,
  "name": "string",
  "description": "string",
  "stamp": {
    "creation": "2019-08-24T14:15:22Z",
    "modification": "2019-08-24T14:15:22Z"
  },
  "active": true,
  "settings": {
    "urgent": true,
    "category": 0,
    "purpose": {
      "type": "string"
    },
    "expiration": {
      "type": "string"
    },
    "mp": {}
  },
  "application": "2b22d485-f04e-492b-b364-e14f8506726a",
  "task": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "scheduler": {
      "type": "string"
    }
  },
  "versions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "master": true,
      "label": "string",
      "stamp": {
        "creation": "2019-08-24T14:15:22Z",
        "modification": "2019-08-24T14:15:22Z"
      },
      "scripting": {
        "version": "string"
      },
      "content": {
        "type": "string"
      },
      "redirection": {
        "type": "string"
      },
      "channel": {
        "type": "string"
      }
    }
  ]
}

Delete a notification

Request

Path
idinteger(int32)required

The notification's id to delete

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 DELETE \
  'https://api-cm.np6.com/notifications/{id}' \
  -H 'X-Key: string'

Responses

No Content

Render the "master" version of 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 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}/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.