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/

Good to know

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

get the targets in redlist mail

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

Responses

No Content

get the targets in redlist sms

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

Responses

No Content

Update a bounce of the target

Request

Path
idstringrequired

Target Id

fieldIdinteger(int32)required

Field 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

Bounce Data

typestring
Discriminator
fieldIdinteger(int32)

Field Id

detailobject

Bounce Detail

messagestring

Message

timestampstring or null(date-time)

Insertion Date

curl -i -X PUT \
  'https://api-cm.np6.com/targets/{id}/bounces/{fieldId}' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "type": "hardDomain",
    "fieldId": 0,
    "detail": {
      "message": "string"
    },
    "timestamp": "2019-08-24T14:15:22Z"
  }'

Responses

No Content

Field

Operations

Enumeration

Operations

Segment

Operations

Import

Operations

Subscription

Operations

Contact

Operations

Webtask

Operations

Compilable

Operations

Mobile Application

Operations

Category

Operations

Marketing Pressure

Operations