Skip to content
/
Retrieve subscriptions fo...

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

Create or update a subscription

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

The subscription data to create or update

idstring(uuid)

Defines the subscription ID.

lifecycleobject

Defines the lifecycle information of the subscription.

creationobject

Defines the creation information for a resource.

modificationobject

Defines the modification information for a resource.

applicationstring(uuid)

Defines the application associated with the subscription.

providerobject

Defines the provider information used to push notifications.

typestring
Discriminator
tokenstring

Token value

contactobject

Defines the contact bound to the subscription.

typestring
Discriminator
valuestring

Identifier of the contact

curl -i -X PUT \
  https://api-cm.np6.com/subscriptions \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "id": "0581e259-9039-487c-a94e-ff8c3944f956",
    "application": "56c874e9-2f8e-4b60-ab4b-6410c3238352",
    "provider": {
      "type": "firebase",
      "token": "d4FAelIfREOTW2TPig-f9r:APA91bGQj91UnatpGQNFI6MMUxYo...."
    },
    "contact": {
      "type": "footprint",
      "id": "00000001",
      "unicity": "foobar",
      "hash": "3858f62230ac3c915f300c664312c63f"
    }
  }'

Responses

The created or updated subscription

Bodyapplication/json
idstring(uuid)

Defines the subscription ID.

lifecycleobject

Defines the lifecycle information of the subscription.

creationobject

Defines the creation information for a resource.

modificationobject

Defines the modification information for a resource.

applicationstring(uuid)

Defines the application associated with the subscription.

providerobject

Defines the provider information used to push notifications.

typestring
Discriminator
tokenstring

Token value

contactobject

Defines the contact bound to the subscription.

typestring
Discriminator
valuestring

Identifier of the contact

Response
application/json
{
  "id": "0581e259-9039-487c-a94e-ff8c3944f956",
  "lifecycle": {
    "creation": {
      "date": "2023-05-22T08:20:05.215Z",
      "user": null
    }
  },
  "application": "56c874e9-2f8e-4b60-ab4b-6410c3238352",
  "provider": {
    "type": "firebase",
    "token": "d4FAelIfREOTW2TPig-f9r:APA91bGQj91UnatpGQNFI6MMUxYo...."
  },
  "contact": {
    "type": "footprint",
    "id": "00000001",
    "unicity": "foobar",
    "hash": "3858f62230ac3c915f300c664312c63f"
  }
}

Retrieve subscriptions for the specified contact id

Request

Path
idstringrequired

The id of the contact used to retrieve the subscriptions

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/targets/{id}/subscriptions' \
  -H 'X-Key: string'

Responses

A list of subscriptions

Bodyapplication/jsonArray [
idstring(uuid)

Defines the subscription ID.

lifecycleobject

Defines the lifecycle information of the subscription.

creationobject

Defines the creation information for a resource.

modificationobject

Defines the modification information for a resource.

applicationstring(uuid)

Defines the application associated with the subscription.

providerobject

Defines the provider information used to push notifications.

typestring
Discriminator
tokenstring

Token value

contactobject

Defines the contact bound to the subscription.

typestring
Discriminator
valuestring

Identifier of the contact

]
Response
application/json
[
  {
    "id": "0581e259-9039-487c-a94e-ff8c3944f956",
    "lifecycle": {
      "creation": {
        "date": "2023-05-22T08:20:05.215Z",
        "user": null
      }
    },
    "application": "56c874e9-2f8e-4b60-ab4b-6410c3238352",
    "provider": {
      "type": "firebase",
      "token": "d4FAelIfREOTW2TPig-f9r:APA91bGQj91UnatpGQNFI6MMUxYo...."
    },
    "contact": {
      "type": "footprint",
      "id": "00000001",
      "unicity": "foobar",
      "hash": "3858f62230ac3c915f300c664312c63f"
    }
  },
  {
    "id": "ee3c161a-2ab2-4f10-b4f8-bd501eb14e50",
    "lifecycle": {
      "creation": {
        "date": "2023-05-21T16:21:22.021Z",
        "user": null
      }
    },
    "application": "56c874e9-2f8e-4b60-ab4b-6410c3238352",
    "provider": {
      "type": "apns",
      "token": "57b15e66ebaa9f2fb67df882821bed6c1fe622bb010cb...."
    },
    "contact": {
      "type": "footprint",
      "id": "00000001",
      "unicity": "foobar",
      "hash": "3858f62230ac3c915f300c664312c63f"
    }
  }
]

Delete subscriptions for the specified contact id

Request

Path
idstringrequired

The id of the contact used to delete the subscriptions

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/targets/{id}/subscriptions' \
  -H 'X-Key: string'

Responses

No Content

Contact

Operations

Webtask

Operations

Compilable

Operations

Mobile Application

Operations

Category

Operations

Marketing Pressure

Operations
© 2025 - ChapsVision - All Rights Reserved.