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

Field

Operations

Enumeration

Operations

Segment

Operations

Import

Operations

Subscription

Operations

Contact

Operations

Webtask

Operations

Compilable

Operations

Mobile Application

Operations

Category

Operations

Retrieve a categoryDeprecated

Request

Path
idinteger(int32)required

The category'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/categories/{id}' \
  -H 'X-Key: string'

Responses

The category

Bodyapplication/json
idinteger(int32)

The category's id

namestring

The category's name

descriptionstring

The category's description

creationDatestring(date-time)

The category's creation date

Response
application/json
{ "id": 0, "name": "string", "description": "string", "creationDate": "2019-08-24T14:15:22Z" }

Update a categoryDeprecated

Request

Path
idinteger(int32)required

The category'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

Data used to update the category

idinteger(int32)

The category's id

namestring

The category's name

descriptionstring

The category's description

creationDatestring(date-time)

The category's creation date

curl -i -X PUT \
  'https://api-cm.np6.com/categories/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "id": 0,
    "name": "string",
    "description": "string",
    "creationDate": "2019-08-24T14:15:22Z"
  }'

Responses

The updated category

Bodyapplication/json
idinteger(int32)

The category's id

namestring

The category's name

descriptionstring

The category's description

creationDatestring(date-time)

The category's creation date

Response
application/json
{ "id": 0, "name": "string", "description": "string", "creationDate": "2019-08-24T14:15:22Z" }

Marketing Pressure

Operations