Skip to content

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

Retrieve bounced targets

Request

Query
queryobjectrequired

Query

startDatestring or null(date-time)

The start date of a timeline query

endDatestring or null(date-time)

The end date of a timeline query

typesArray of integers(int32)

Defines the bounced type wanted
Unknow = 0 Soft = 1 HardDomain = 2 HardUser = 3 HardOther = 4 HardAdministrative = 5 ReportAsSpam = 6

fieldsArray of integers(int32)

Defines the bounced field wanted

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/bounces?query=&startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&types=0&fields=0' \
  -H 'X-Key: string'

Responses

No Content

Retrieve notifications routed by target (experimental)

Request

Path
idstringrequired

id of the target

Query
startstring(date-time)

Defines a start date filter
Specify this parameter to retrieve only events with a timestamp greater than or equal to the specified value
You can use an ISO format date or a timestamp

endstring(date-time)

Defines an end date filter
Specify this parameter to retrieve only events with a timestamp less than the specified value
You can use an ISO format date or a timestamp

sortstring

Defines a sort order applied on events timestamp
By default, events are unordered and may not streamed in the same order between two requests
You should use this query parameter if you want to guarantee the sort order of events

Enum"asc""desc"
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}/notifications?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z&sort=asc' \
  -H 'X-Key: string'

Responses

Bodyapplication/jsonArray [
notification_keyinteger(int32)

Notification id

targetstring

Target id

libellestring

Libelle notification

dismissstring or null(date-time)

Dismiss date

activationstring or null(date-time)

Activation date

redirectionstring or null(date-time)

Redirection date

impressionstring or null(date-time)

Impression date

]
Response
application/json
[
  {
    "notification_key": 0,
    "target": "string",
    "libelle": "string",
    "dismiss": "2019-08-24T14:15:22Z",
    "activation": "2019-08-24T14:15:22Z",
    "redirection": "2019-08-24T14:15:22Z",
    "impression": "2019-08-24T14:15:22Z"
  }
]

Retrieve all segments associated with a target

Request

Path
idstringrequired

The target’s id

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

Responses

Array of segments id

Bodyapplication/jsonArray [
integer(int32)
]
Response
application/json
[
  0
]

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.