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
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

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.

Bodyapplication/json
idstring

The target's ID

timestampstring or null(date-time)

The date of the redlist

origininteger(int32)

The origin of the redlist
Unknown type : 0 Listed by API : 1 Listed by imports : 2 Listed by form : 3 Listed in unsubscribe redlist : 4 Listed in complaint : 5 Listed in SMS Stop : 6 Listed in SMS Blacklist : 7 Listed in SMS admnistrative : 8 Listed in SMS specific : 9

Enum0123456789
detailobject

The detail of the redlist

curl -i -X POST \
  'https://api-cm.np6.com/targets/{id}/redlist/mail' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "id": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "origin": 0,
    "detail": {}
  }'

Responses

No Content

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.

Bodyapplication/json
idstring

The target's ID

timestampstring or null(date-time)

The date of the redlist

origininteger(int32)

The origin of the redlist
Unknown type : 0 Listed by API : 1 Listed by imports : 2 Listed by form : 3 Listed in unsubscribe redlist : 4 Listed in complaint : 5 Listed in SMS Stop : 6 Listed in SMS Blacklist : 7 Listed in SMS admnistrative : 8 Listed in SMS specific : 9

Enum0123456789
detailobject

The detail of the redlist

curl -i -X POST \
  'https://api-cm.np6.com/targets/{id}/redlist/sms' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "id": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "origin": 0,
    "detail": {}
  }'

Responses

No Content

Request

Query
queryobject

Start and End dates optional

startDatestring or null(date-time)

The start date of a timeline query

endDatestring or null(date-time)

The end date of a timeline query

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

Responses

No Content

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations