Skip to content
/
Retrieve the specified no...

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

Create a notification

Request

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 create 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 POST \
  https://api-cm.np6.com/notifications \
  -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 created 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"
      }
    }
  ]
}

Retrieve the specified notification

Request

Path
idinteger(int32)required

The notification's id to get

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}' \
  -H 'X-Key: string'

Responses

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

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

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.