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

Update a segmentDeprecated

Request

Path
idinteger(int32)required

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

typestring
Discriminator
idinteger(int32)

The segment's id

namestring

The segment's name

descriptionstring

The segment's description

creationstring or null(date-time)

The segment's creation date

expirationstring or null(date-time)

The segment's expiration date

isTestboolean or null

If true, the segment can be used for action test phases

targetsCountinteger or null(int32)

Estimated number of targets in the segment

parentIdinteger or null(int32)

The parent segment's id

searchIdinteger or null(int32)

The search id

curl -i -X PUT \
  'https://api-cm.np6.com/segments/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "type": "static",
    "id": 41,
    "name": "an updated name",
    "description": "an updated description",
    "expiration": "2025-03-01T11:00:00Z"
  }'

Responses

The updated segment

Bodyapplication/json
typestring
Discriminator
idinteger(int32)

The segment's id

namestring

The segment's name

descriptionstring

The segment's description

creationstring or null(date-time)

The segment's creation date

expirationstring or null(date-time)

The segment's expiration date

isTestboolean or null

If true, the segment can be used for action test phases

targetsCountinteger or null(int32)

Estimated number of targets in the segment

parentIdinteger or null(int32)

The parent segment's id

searchIdinteger or null(int32)

The search id

Response
application/json
{ "type": "static", "id": 41, "name": "an updated name segment", "description": "an updated description", "creation": "2023-03-01T11:00:00Z", "expiration": "2025-03-01T11:00:00Z", "isTest": false, "targetsCount": 4398 }

Retrieve a segment's targetsDeprecated

Request

Path
idinteger(int32)required

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

Responses

Array of target ids

Bodyapplication/jsonArray [
string
]
Response
application/json
[ "000PKXK4", "000PKXK5", "000PKXK6", "000PKXK7", "000R4EJO", "000R4MG8", "000R4O1C", "000R4S0S", "000R7FNX", "000R7FNY" ]

Add targets to a static segmentDeprecated

Request

Maximum of 50 targets If using unicity values to identify targets and the account has more than one unicity criteria configured, the values must be concatenated and sent as a single string for each target.

Path
idinteger(int32)required

The segment'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.

Body

An array of target identifiers

Array [
string
]
curl -i -X PUT \
  'https://api-cm.np6.com/segments/{id}/targets' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '[
    "000PKXK4",
    "000PKXK5",
    "000PKXK6",
    "000PKXK7",
    "000R4EJO",
    "000R4MG8",
    "000R4O1C",
    "000R4S0S",
    "000R7FNX",
    "000R7FNY"
  ]'

Responses

Number of targets added to the segment

Body
integer(int32)
Response
10

Import

Operations

Subscription

Operations

Contact

Operations

Webtask

Operations

Compilable

Operations

Mobile Application

Operations

Category

Operations

Marketing Pressure

Operations