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

Retrieve all fieldsDeprecated

Request

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/fields \
  -H 'X-Key: string'

Responses

An array of fields

Bodyapplication/jsonArray [
typestring
Discriminator
idinteger(int32)

Id of the field

namestring

Name the field

isUnicityboolean

True if used on unicity

isMandatoryboolean

True this field is mandatory

isCriterionboolean

True if this field is a segmentation criterion

constraintobject

The associated constraint

operatorinteger(int32)

Constraint operator

Enum012345
valuestring

Constraint value

valueListIdinteger(int32)

The id of the associated value list

]
Response
application/json
[ { "type": "string" } ]

Create a fieldDeprecated

Request

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 create the field

typestring
Discriminator
idinteger(int32)

Id of the field

namestring

Name the field

isUnicityboolean

True if used on unicity

isMandatoryboolean

True this field is mandatory

isCriterionboolean

True if this field is a segmentation criterion

constraintobject

The associated constraint

operatorinteger(int32)

Constraint operator

Enum012345
valuestring

Constraint value

valueListIdinteger(int32)

The id of the associated value list

curl -i -X POST \
  https://api-cm.np6.com/fields \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "type": "singleSelectList",
    "id": 0,
    "name": "string",
    "isUnicity": true,
    "isMandatory": true,
    "isCriterion": true,
    "constraint": {
      "operator": 0,
      "value": "string"
    },
    "valueListId": 0
  }'

Responses

The created field

Bodyapplication/json
typestring
Discriminator
idinteger(int32)

Id of the field

namestring

Name the field

isUnicityboolean

True if used on unicity

isMandatoryboolean

True this field is mandatory

isCriterionboolean

True if this field is a segmentation criterion

constraintobject

The associated constraint

operatorinteger(int32)

Constraint operator

Enum012345
valuestring

Constraint value

valueListIdinteger(int32)

The id of the associated value list

Response
application/json
{ "type": "singleSelectList", "id": 0, "name": "string", "isUnicity": true, "isMandatory": true, "isCriterion": true, "constraint": { "operator": 0, "value": "string" }, "valueListId": 0 }

Retrieve a fieldDeprecated

Request

Path
idinteger(int32)required

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

Responses

The field

Bodyapplication/json
typestring
Discriminator
idinteger(int32)

Id of the field

namestring

Name the field

isUnicityboolean

True if used on unicity

isMandatoryboolean

True this field is mandatory

isCriterionboolean

True if this field is a segmentation criterion

constraintobject

The associated constraint

operatorinteger(int32)

Constraint operator

Enum012345
valuestring

Constraint value

valueListIdinteger(int32)

The id of the associated value list

Response
application/json
{ "type": "singleSelectList", "id": 0, "name": "string", "isUnicity": true, "isMandatory": true, "isCriterion": true, "constraint": { "operator": 0, "value": "string" }, "valueListId": 0 }

Enumeration

Operations

Segment

Operations

Import

Operations

Subscription

Operations

Contact

Operations

Webtask

Operations

Compilable

Operations

Mobile Application

Operations

Category

Operations

Marketing Pressure

Operations