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

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

Remove all targets from 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.

curl -i -X DELETE \
  'https://api-cm.np6.com/segments/{id}/targets' \
  -H 'X-Key: string'

Responses

No Content

Normalize the telephone field of targets in 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

The normalization request

fieldsobject

Key value pair of the field id that should be normalized
and the list of possible country codes for that field.

property name*Array of stringsadditional property
curl -i -X POST \
  'https://api-cm.np6.com/segments/{id}/normalization' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "fields": {
      "34": [
        "FRA",
        "ESP",
        "ITA"
      ]
    }
  }'

Responses

No Content

Import

Operations

Subscription

Operations

Contact

Operations

Webtask

Operations

Compilable

Operations

Mobile Application

Operations

Category

Operations

Marketing Pressure

Operations