/

Send 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

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

Send message

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

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}/execution' \
  -H 'Content-Type: application/vnd.np6.cm.email' \
  -H 'X-Key: string' \
  -d '[object Object]'

Responses

An execution result

Bodyapplication/json

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

Retrieve all actionsDeprecated

Request

Query

creation_startstring or null(date-time)

Defines a creation start date filter
Specify this parameter to retrieve only actions with a creation date greater than or equal to the specified value
You can use an ISO format date or a timestamp

creation_endstring or null(date-time)

Defines a creation end date filter
Specify this parameter to retrieve only actions with a creation date less than the specified value
You can use an ISO format date or a timestamp

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/actions?creation_end=2019-08-24T14%3A15%3A22Z&creation_start=2019-08-24T14%3A15%3A22Z' \
  -H 'X-Key: string'

Responses

An array of actions

Bodyapplication/jsonArray [

typestring

Discriminator

idstring

The action's identifier

namestring

The action's name

creationDatestring(date-time)

The action's creation date, in UTC

informationsobject

Informations

folderinteger or null(int32)

Defines the folder in which the action is stored

categoryinteger or null(int32)

Defines the category of the action

stateinteger or null(int32)

Defines the current state of the action

Enum10203035363840505560

settingsobject

Settings

schedulerobject

Scheduler

typestring

Discriminator

startDatestring or null(date-time)

StartDate

endDatestring or null(date-time)

EndDate

monitorobject

Monitor

lastSentobject

LastSent

]

Response

application/json

[
  {
    "type": "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