Skip to content
/
Retrieve all notifiable a...

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

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

Retrieve all notifiable applications

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.

curl -i -X GET \
  https://api-cm.np6.com/parameters/applications \
  -H 'X-Key: string'

Responses

A list of notifiable applications

Bodyapplication/jsonArray [
typestring
Discriminator
idstring(uuid)

Defines the unique id of the notifiable application

namestring

Defines the name of the notifiable application

descriptionstring

Defines the description of the notifiable application

activeboolean

Defines the online state of the application

stampobject

Defines the stamp informations of the notifiable application

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

iconstring

Defines the base64 value of the notifiable application icon

providersArray of objects

Defines a list of providers used to deliver notifications to the application

typestring
Discriminator
keystring

Defines the "firebase" api key used to send notifications

senderstring

Defines the "firebase" sender id used to send notifications

routesArray of objects

Defines a list of exisiting notifiable application routes used to preform redirections

namestring

Defines the name of the route

valueobject

Defines the value of the route

defaultboolean

Defines this route as the default route

channelsArray of objects

Defines a list of exisiting notifiable application channels used to handle display behaviors

namestring

Defines the name of the channel

valueobject

Defines the value of the channel

defaultboolean

Defines this route as the default route

]
Response
application/json
[
  {
    "type": "native",
    "id": "2399f53f-1b0e-4cbb-b81e-26c0f11359ca",
    "name": "my mobile app",
    "description": "An application that handles push notifications using firebase",
    "active": true,
    "stamp": {
      "creation": "2023-01-01T12:01:02.423Z",
      "modification": "2023-01-07T08:23:03.1Z"
    },
    "icon": null,
    "providers": [
      {
        "type": "firebase",
        "key": "...",
        "sender": "np6.push"
      }
    ],
    "routes": [
      {
        "name": "defaultUrl",
        "value": {
          "type": "literal",
          "value": "app://push-app/home"
        },
        "default": true
      }
    ],
    "channels": null
  },
  {
    "type": "native",
    "id": "afda95ef-2c0a-4e2d-a3b9-42b18843c08e",
    "name": "another mobile app",
    "description": "An application that handles push notifications using a http provider",
    "active": false,
    "stamp": {
      "creation": "2024-01-03T10:22:34.423Z",
      "modification": "2024-04-08T08:23:19.23Z"
    },
    "icon": null,
    "providers": [
      {
        "type": "http",
        "url": "https://my-application.push/",
        "headers": [
          {
            "key": "foo",
            "value": "bar"
          }
        ],
        "concurrency": 50
      }
    ],
    "routes": [
      {
        "name": "home",
        "value": {
          "type": "literal",
          "value": "app://homepage"
        },
        "default": true
      }
    ],
    "channels": null
  },
  {
    "type": "native",
    "id": "a2261c17-a896-4c57-ad1f-6a3f2d83a2cc",
    "name": "another mobile app",
    "description": "An application that handles push notifications using firebase and apns",
    "active": false,
    "stamp": {
      "creation": "2024-02-01T02:02:43.123Z",
      "modification": "2024-02-01T07:20:11.876Z"
    },
    "icon": null,
    "providers": [
      {
        "type": "firebase",
        "key": "...",
        "sender": "np6.push"
      },
      {
        "type": "apns",
        "certificate": {
          "type": "p12",
          "value": "...",
          "password": "...",
          "expiration": "2025-12-31T23:59:59.999Z"
        },
        "bundle": "com.np6.push"
      }
    ],
    "routes": [
      {
        "name": "home",
        "value": {
          "type": "literal",
          "value": "app://homepage"
        },
        "default": true
      }
    ],
    "channels": [
      {
        "name": "marketing",
        "value": {
          "type": "literal",
          "value": "marketing"
        },
        "default": true
      }
    ]
  }
]

Create a notifiable application

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 notifiable application

typestring
Discriminator
idstring(uuid)

Defines the unique id of the notifiable application

namestring

Defines the name of the notifiable application

descriptionstring

Defines the description of the notifiable application

activeboolean

Defines the online state of the application

stampobject

Defines the stamp informations of the notifiable application

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

iconstring

Defines the base64 value of the notifiable application icon

providersArray of objects

Defines a list of providers used to deliver notifications to the application

typestring
Discriminator
keystring

Defines the "firebase" api key used to send notifications

senderstring

Defines the "firebase" sender id used to send notifications

routesArray of objects

Defines a list of exisiting notifiable application routes used to preform redirections

namestring

Defines the name of the route

valueobject

Defines the value of the route

defaultboolean

Defines this route as the default route

channelsArray of objects

Defines a list of exisiting notifiable application channels used to handle display behaviors

namestring

Defines the name of the channel

valueobject

Defines the value of the channel

defaultboolean

Defines this route as the default route

curl -i -X POST \
  https://api-cm.np6.com/parameters/applications \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "type": "native",
    "id": null,
    "name": "another mobile app",
    "description": "An application that handles push notifications using firebase and apns",
    "active": false,
    "stamp": null,
    "icon": null,
    "providers": [
      {
        "type": "firebase",
        "key": "...",
        "sender": "np6.push"
      },
      {
        "type": "apns",
        "certificate": {
          "type": "p12",
          "value": "...",
          "password": "...",
          "expiration": "2025-12-31T23:59:59.999Z"
        },
        "bundle": "com.np6.push"
      }
    ],
    "routes": [
      {
        "name": "home",
        "value": {
          "type": "literal",
          "value": "app://homepage"
        },
        "default": true
      }
    ],
    "channels": [
      {
        "name": "marketing",
        "value": {
          "type": "literal",
          "value": "marketing"
        },
        "default": true
      }
    ]
  }'

Responses

The created notifiable application

Bodyapplication/json
typestring
Discriminator
idstring(uuid)

Defines the unique id of the notifiable application

namestring

Defines the name of the notifiable application

descriptionstring

Defines the description of the notifiable application

activeboolean

Defines the online state of the application

stampobject

Defines the stamp informations of the notifiable application

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

iconstring

Defines the base64 value of the notifiable application icon

providersArray of objects

Defines a list of providers used to deliver notifications to the application

typestring
Discriminator
keystring

Defines the "firebase" api key used to send notifications

senderstring

Defines the "firebase" sender id used to send notifications

routesArray of objects

Defines a list of exisiting notifiable application routes used to preform redirections

namestring

Defines the name of the route

valueobject

Defines the value of the route

defaultboolean

Defines this route as the default route

channelsArray of objects

Defines a list of exisiting notifiable application channels used to handle display behaviors

namestring

Defines the name of the channel

valueobject

Defines the value of the channel

defaultboolean

Defines this route as the default route

Response
application/json
{
  "type": "native",
  "id": "a2261c17-a896-4c57-ad1f-6a3f2d83a2cc",
  "name": "another mobile app",
  "description": "An application that handles push notifications using firebase and apns",
  "active": false,
  "stamp": {
    "creation": "2024-02-01T02:02:43.123Z",
    "modification": "2024-02-01T02:02:43.123Z"
  },
  "icon": null,
  "providers": [
    {
      "type": "firebase",
      "key": "...",
      "sender": "np6.push"
    },
    {
      "type": "apns",
      "certificate": {
        "type": "p12",
        "value": "...",
        "password": "...",
        "expiration": "2025-12-31T23:59:59.999Z"
      },
      "bundle": "com.np6.push"
    }
  ],
  "routes": [
    {
      "name": "home",
      "value": {
        "type": "literal",
        "value": "app://homepage"
      },
      "default": true
    }
  ],
  "channels": [
    {
      "name": "marketing",
      "value": {
        "type": "literal",
        "value": "marketing"
      },
      "default": true
    }
  ]
}

Retrieve the specified notifiable application

Request

Path
uuidstring(uuid)required

The notifiable application's id to retrieve

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/parameters/applications/{uuid}' \
  -H 'X-Key: string'

Responses

A notifiable application

Bodyapplication/json
typestring
Discriminator
idstring(uuid)

Defines the unique id of the notifiable application

namestring

Defines the name of the notifiable application

descriptionstring

Defines the description of the notifiable application

activeboolean

Defines the online state of the application

stampobject

Defines the stamp informations of the notifiable application

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

iconstring

Defines the base64 value of the notifiable application icon

providersArray of objects

Defines a list of providers used to deliver notifications to the application

typestring
Discriminator
keystring

Defines the "firebase" api key used to send notifications

senderstring

Defines the "firebase" sender id used to send notifications

routesArray of objects

Defines a list of exisiting notifiable application routes used to preform redirections

namestring

Defines the name of the route

valueobject

Defines the value of the route

defaultboolean

Defines this route as the default route

channelsArray of objects

Defines a list of exisiting notifiable application channels used to handle display behaviors

namestring

Defines the name of the channel

valueobject

Defines the value of the channel

defaultboolean

Defines this route as the default route

Response
application/json
{
  "type": "native",
  "id": "a2261c17-a896-4c57-ad1f-6a3f2d83a2cc",
  "name": "another mobile app",
  "description": "An application that handles push notifications using firebase and apns",
  "active": false,
  "stamp": {
    "creation": "2024-02-01T02:02:43.123Z",
    "modification": "2024-02-01T07:20:11.876Z"
  },
  "icon": null,
  "providers": [
    {
      "type": "firebase",
      "key": "...",
      "sender": "np6.push"
    },
    {
      "type": "apns",
      "certificate": {
        "type": "p12",
        "value": "...",
        "password": "...",
        "expiration": "2025-12-31T23:59:59.999Z"
      },
      "bundle": "com.np6.push"
    }
  ],
  "routes": [
    {
      "name": "home",
      "value": {
        "type": "literal",
        "value": "app://homepage"
      },
      "default": true
    }
  ],
  "channels": [
    {
      "name": "marketing",
      "value": {
        "type": "literal",
        "value": "marketing"
      },
      "default": true
    }
  ]
}

Category

Operations

Marketing Pressure

Operations
© 2025 - ChapsVision - All Rights Reserved.