/

Render multiple messages

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.

Servers

Production server

https://api-cm.np6.com/

Good to know

Email & SMS

Operations

Unvalidate an action

Request

Path

idstringrequired

The id of the Action

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 unvalidate the action

fortestboolean or null

Defines the availibity of the test

campaignAnalyserboolean or null

Defines the use of the campaign analyser - the feature needs to be activated for the account

testSegmentsArray of integers(int32)

Defines segment IDs list used to test the action

mediaForTeststring

Defines a overriden media used to test the action

textandHtmlboolean or null

Defines the send of both HTML and Text versions

commentsstring

Defines additional comments

variablesArray of objects

Defines a list of variables as key value pair used to execute proof

curl -i -X DELETE \
  'https://api-cm.np6.com/actions/{id}/validation' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "fortest": true,
    "campaignAnalyser": true,
    "testSegments": [
      0
    ],
    "mediaForTest": "string",
    "textandHtml": true,
    "comments": "string",
    "variables": [
      {}
    ]
  }'

Responses

No Content

Render multiple messages

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.

Body

A list of render definitions

Array [

receiverobject

The receiver identification

typestring

Discriminator

valuestring

Id of the target

relatedobject

The related identification

typestring

Discriminator

valuestring

Id of the target

dataobject

Rendering data

blocksArray of objects

Blocks of additional data

variablesArray of objects

Additionnal variables

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

headersobject

Headers overrides

fromobject

Email From template overriding

replystring

Email Reply template overriding

subjectstring

Subjet override

contentobject

Content override

typestring

Discriminator

htmlstring

Html content

textstring

Text content

ampstring

AMP content

contextobject

Views overrides

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

]

curl -i -X POST \
  'https://api-cm.np6.com/actions/{id}/renders' \
  -H 'Content-Type: application/vnd.np6.cm.email' \
  -H 'X-Key: string' \
  -d '[object Object]'

Responses

A list of render result

Bodyapplication/jsonArray [

typestring

Discriminator

recipientstring

The rendered recipient

senderobject

The rendered sender values

bouncestring

The sender bounce value

labelstring

The sender label

replystring

The replyto email header

valuestring

The sender value

subjectstring

The rendered subject

htmlstring

The rendered html

textstring

The rendered text

ampstring

The rendered amp

headersobject

The rendered email headers

property name*stringadditional property

]

Response

application/json

[
  {
    "type": "string"
  }
]

Render a message

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.

Body

A render definition

receiverobject

The receiver identification

typestring

Discriminator

valuestring

Id of the target

relatedobject

The related identification

typestring

Discriminator

valuestring

Id of the target

dataobject

Rendering data

blocksArray of objects

Blocks of additional data

variablesArray of objects

Additionnal variables

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

headersobject

Headers overrides

fromobject

Email From template overriding

replystring

Email Reply template overriding

subjectstring

Subjet override

contentobject

Content override

typestring

Discriminator

htmlstring

Html content

textstring

Text content

ampstring

AMP content

contextobject

Views overrides

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

curl -i -X POST \
  'https://api-cm.np6.com/actions/{id}/render' \
  -H 'Content-Type: application/vnd.np6.cm.email' \
  -H 'X-Key: string' \
  -d '[object Object]'

Responses

A render result

Bodyapplication/json

typestring

Discriminator

recipientstring

The rendered recipient

senderobject

The rendered sender values

bouncestring

The sender bounce value

labelstring

The sender label

replystring

The replyto email header

valuestring

The sender value

subjectstring

The rendered subject

htmlstring

The rendered html

textstring

The rendered text

ampstring

The rendered amp

headersobject

The rendered email headers

property name*stringadditional property

Response

application/json

{
  "type": "success",
  "recipient": "string",
  "sender": {
    "bounce": "string",
    "label": "string",
    "reply": "string",
    "value": "string"
  },
  "subject": "string",
  "html": "string",
  "text": "string",
  "amp": "string",
  "headers": {
    "property1": "string",
    "property2": "string"
  }
}

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