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

Render linksDeprecated

Request

Path
idstringrequired

The action's id to render

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

A render definition

receiverobject

The receiver identification

typestring
Discriminator
valuestring

Id of the target

dataobject

Render data

variablesArray of objects

Additionnal variables

contextobject

Render context

idstring

The message id

displayinteger(int32)

Underlying display configuration

Enum0124816
renderinteger(int32)

The content id to render

recipientstring

Email of the recipients to override the send

stampobject

Stamp data

timeinteger(int64)

Creation time of the stamp
This is the number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.

idstring(uuid)

The stamp id

threadstring(uuid)

The thread id

setstring(uuid)

The set id

linksArray of objects

Links to render

typestring
Discriminator
destinationobject

The destination of the system link

curl -i -X POST \
  'https://api-cm.np6.com/actions/{id}/render/links' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "receiver": {
      "type": "string"
    },
    "data": {},
    "variables": [
      {}
    ],
    "context": {
      "id": "string",
      "display": 0,
      "render": 0,
      "recipient": "string"
    },
    "stamp": {
      "time": 0,
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "thread": "4e557e2e-a322-4083-8cda-d0357ed0cb0c",
      "set": "6218c222-bd9f-4d43-9cbb-d1adfe7e63bd"
    },
    "links": [
      {
        "type": "string"
      }
    ]
  }'

Responses

A render result

Bodyapplication/json
typestring
Discriminator
linksArray of strings

Rendered links

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

Send a messageDeprecated

Request

Send a message (email or sms) to a target. For email messages only, optionally replace the message's configured content and headers with those passed as parameters

Path
idstringrequired

The action's id

targetIdstringrequired

The target'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 message request model

dataobject

BsonDocument to pass additional data

contentobject

If the message is an email, the content of the message will be replaced by this parameter

htmlstring

The replacement html content of the message

textstring

The replacement text content of the message

headerobject

If the message is an email, the header of the message will be replaced by this parameter

subjectstring

The replacement message subject

mailFromstring

The replacement from address

replyTostring

The replacement reply-to address

curl -i -X POST \
  'https://api-cm.np6.com/actions/{id}/targets/{targetId}' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "data": {},
    "content": {
      "html": "string",
      "text": "string"
    },
    "header": {
      "subject": "string",
      "mailFrom": "string",
      "replyTo": "string"
    }
  }'

Responses

No Content

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

Marketing Pressure

Operations