/

Render a message

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

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"
  }
}

Send messages

Request

Path

idstringrequired

The action's id to send

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 message definitions

Array [

recipientobject

The recipient identification

typestring

Discriminator

valuestring

Value used to identify target

relatedobject

The related identification

typestring

Discriminator

valuestring

Value used to identify target

copiesArray of objects

Carbon copies

typestring

Discriminator

blindboolean

Value used to set carbon copy to "blind" (bcc)

valuestring

Value used to identify the carbon copy

headersobject

Template "headers"

fromobject

Email From template overriding

replystring

Email Reply template overriding

subjectstring

Template "subject"

attachmentsArray of objects

Attachments

namestring

Value used to set attachment's file name

mimestring

Value used to set attachment's mime type

dataobject

Value used to set attachment's data

contentobject

Views overrides

typestring

Discriminator

htmlstring

Html content

textstring

Text content

ampstring

AMP content

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

urgentboolean

Indicates the priority of this message

importantboolean

Indicates the importance of this message

]

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

Responses

A list of execution result

Bodyapplication/jsonArray [

typestring

Discriminator

idstring

Message ID

recipientobject

Final Recipient

typestring

Discriminator

valuestring

Value used to identify target

]

Response

application/json

[
  {
    "type": "success",
    "id": "497a760d-e444-484f-b964-125cf548bb9c",
    "recipient": {
      "type": "footprint",
      "id": "00000001",
      "unicity": "unicity_1",
      "hash": "409ba38aa13699d31caa8b42c94a5dc8"
    }
  },
  {
    "type": "success",
    "id": "804b1456-1280-4744-b556-29a36031b44f",
    "recipient": {
      "type": "footprint",
      "id": "00000002",
      "unicity": "unicity_2",
      "hash": "2f5c786adbb6ca1fb4e2226104b0fbc7"
    }
  }
]

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