Skip to content
/
Retrieve a target (experi...

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

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

Remove a target from a segment

Request

Path
targetIdstringrequired

The Id of the target

segmentIdinteger(int32)required

The Id of the segment

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

Responses

No Content

Retrieve a target (experimental)

Request

Path
idstringrequired

id of the target

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/vnd.mperf.v8.model.v1+json

comma separated fieldids to filter output

object
curl -i -X GET \
  'https://api-cm.np6.com/targets/{id}' \
  -H 'Content-Type: application/vnd.mperf.v8.model.v1+json' \
  -H 'X-Key: string' \
  -d '{}'

Responses

Body
idstring

The Id of the target

hashstring

The Hash of the target

creationDatestring(date-time)

The creation date of the target

lastUpdateDatestring(date-time)

The last update of the target

fieldsobject

The values of the target defined by the Fields

Response
{
  "id": "string",
  "hash": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "fields": {}
}

Update a target

Request

Path
idstringrequired

Id of the target to to update

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 target

object
curl -i -X PUT \
  'https://api-cm.np6.com/targets/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{}'

Responses

The updated target

Bodyapplication/json
idstring

The Id of the target

hashstring

The Hash of the target

creationDatestring(date-time)

The creation date of the target

lastUpdateDatestring(date-time)

The last update of the target

fieldsobject

The values of the target defined by the Fields

bounceArray of objects

The bounces of the target

fieldinteger(int32)

The id of field of the bounce

typestring

The Type of the bounce

Enum"Validé""Soft""ReportAsSpam""HardDomain""HardUser""HardOther""HardRules"
timestampstring(date-time)

The date of the bounce

reasonstring

The Reason of the bounce

redListobject

The redList infos of the target

mailobject

RedListMail

smsobject

RedListSms

Response
application/json
{
  "id": "string",
  "hash": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "fields": {},
  "bounce": [
    {
      "field": 0,
      "type": "Validé",
      "timestamp": "2019-08-24T14:15:22Z",
      "reason": "string"
    }
  ],
  "redList": {
    "mail": {
      "timestamp": "2019-08-24T14:15:22Z",
      "reason": 0
    },
    "sms": {
      "timestamp": "2019-08-24T14:15:22Z",
      "reason": 0
    }
  }
}

Field

Operations

Enumeration

Operations

Segment

Operations

Import

Operations

Subscription

Operations

Contact

Operations

Webtask

Operations

Compilable

Operations

Mobile Application

Operations

Category

Operations

Marketing Pressure

Operations
© 2025 - ChapsVision - All Rights Reserved.