Skip to content
/
Retrieve the specified ac...

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

Retrieve the specified action

Request

Path
idstringrequired

The action'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.

curl -i -X GET \
  'https://api-cm.np6.com/actions/{id}' \
  -H 'X-Key: string'

Responses

The action

Bodyapplication/json
typestring
Discriminator
idstring

Defines the id of the action

namestring

Defines the name of the action

descriptionstring

Defines the description of the action

creationDatestring(date-time)

Defines the creation date of the action

informationsobject

Defines general informations of the action

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

Defines general settings of the email action

templatingobject

Defines the templating settings of the email action

editionModeinteger(int32)

Defines the edition mode of the email action

Enum012
purposeobject

Defines the purpose of the email action

consentinteger(int32)

Defines the consent setting of the email action

Enum012
priorityboolean

Defines the priority of the email action. Set this property to "true" for high priority, which will utilize a dedicated queue. Set to "false" otherwise.

importanceboolean

Defines the importance of the action. Set this property to "true" to mark the email as "important" and display an exclamation point in supported webmail clients. Set to "false" otherwise.

environmentobject

Defines variables used to personalize content

fieldinteger(int32)

Defines the contact email field id of the receiving media

culturestring

Defines the culture of the action

contentFormatinteger(int32)

Defines the email format to send

Enum12
useFormLinkSSLboolean

Defines a settings to apply ssl to NP6 form links

sendingProfileinteger or null(int32)

Defines the id of the sending profile to use

performanceobject

Defines the performance objectives of the action

mpobject

Defines the marketing pressure settings of the action

webAnalyserinteger or null(int32)

Defines the id of the webanalyser connector to use

archiveboolean or null

Archive settings

contentobject

Defines the content of the email action

headersobject

Defines headers of the email action

subjectstring

Defines the subject of the email action

htmlstring

Defines the HTML content of the email action

textstring

Defines the Text content of the email action

Response
application/json
{
  "type": "mailMessage",
  "id": "string",
  "name": "string",
  "description": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "informations": {
    "folder": 0,
    "category": 0,
    "state": 10
  },
  "settings": {
    "templating": {
      "version": "string"
    },
    "editionMode": 0,
    "purpose": {
      "type": "string"
    },
    "consent": 0,
    "priority": true,
    "importance": true,
    "environment": {},
    "field": 0,
    "culture": "string",
    "contentFormat": 1,
    "useFormLinkSSL": true,
    "sendingProfile": 0,
    "performance": {
      "openingRate": 0.1,
      "clickRate": 0.1,
      "unsubscribedRate": 0.1
    },
    "mp": {
      "use": true,
      "increment": true
    },
    "webAnalyser": 0,
    "archive": true
  },
  "content": {
    "headers": {
      "from": {
        "prefix": "string",
        "domain": "string",
        "label": "string"
      },
      "reply": "string"
    },
    "subject": "string",
    "html": "string",
    "text": "string"
  }
}

Update an action

Request

Path
idstringrequired

The action's id 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 action

typestring
Discriminator
idstring

Defines the id of the action

namestring

Defines the name of the action

descriptionstring

Defines the description of the action

creationDatestring(date-time)

Defines the creation date of the action

informationsobject

Defines general informations of the action

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

Defines general settings of the email action

templatingobject

Defines the templating settings of the email action

editionModeinteger(int32)

Defines the edition mode of the email action

Enum012
purposeobject

Defines the purpose of the email action

consentinteger(int32)

Defines the consent setting of the email action

Enum012
priorityboolean

Defines the priority of the email action. Set this property to "true" for high priority, which will utilize a dedicated queue. Set to "false" otherwise.

importanceboolean

Defines the importance of the action. Set this property to "true" to mark the email as "important" and display an exclamation point in supported webmail clients. Set to "false" otherwise.

environmentobject

Defines variables used to personalize content

fieldinteger(int32)

Defines the contact email field id of the receiving media

culturestring

Defines the culture of the action

contentFormatinteger(int32)

Defines the email format to send

Enum12
useFormLinkSSLboolean

Defines a settings to apply ssl to NP6 form links

sendingProfileinteger or null(int32)

Defines the id of the sending profile to use

performanceobject

Defines the performance objectives of the action

mpobject

Defines the marketing pressure settings of the action

webAnalyserinteger or null(int32)

Defines the id of the webanalyser connector to use

archiveboolean or null

Archive settings

contentobject

Defines the content of the email action

headersobject

Defines headers of the email action

subjectstring

Defines the subject of the email action

htmlstring

Defines the HTML content of the email action

textstring

Defines the Text content of the email action

curl -i -X PUT \
  'https://api-cm.np6.com/actions/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "type": "mailMessage",
    "id": "string",
    "name": "string",
    "description": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "informations": {
      "folder": 0,
      "category": 0,
      "state": 10
    },
    "settings": {
      "templating": {
        "version": "string"
      },
      "editionMode": 0,
      "purpose": {
        "type": "string"
      },
      "consent": 0,
      "priority": true,
      "importance": true,
      "environment": {},
      "field": 0,
      "culture": "string",
      "contentFormat": 1,
      "useFormLinkSSL": true,
      "sendingProfile": 0,
      "performance": {
        "openingRate": 0.1,
        "clickRate": 0.1,
        "unsubscribedRate": 0.1
      },
      "mp": {
        "use": true,
        "increment": true
      },
      "webAnalyser": 0,
      "archive": true
    },
    "content": {
      "headers": {
        "from": {
          "prefix": "string",
          "domain": "string",
          "label": "string"
        },
        "reply": "string"
      },
      "subject": "string",
      "html": "string",
      "text": "string"
    }
  }'

Responses

The updated action

Bodyapplication/json
typestring
Discriminator
idstring

Defines the id of the action

namestring

Defines the name of the action

descriptionstring

Defines the description of the action

creationDatestring(date-time)

Defines the creation date of the action

informationsobject

Defines general informations of the action

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

Defines general settings of the email action

templatingobject

Defines the templating settings of the email action

editionModeinteger(int32)

Defines the edition mode of the email action

Enum012
purposeobject

Defines the purpose of the email action

consentinteger(int32)

Defines the consent setting of the email action

Enum012
priorityboolean

Defines the priority of the email action. Set this property to "true" for high priority, which will utilize a dedicated queue. Set to "false" otherwise.

importanceboolean

Defines the importance of the action. Set this property to "true" to mark the email as "important" and display an exclamation point in supported webmail clients. Set to "false" otherwise.

environmentobject

Defines variables used to personalize content

fieldinteger(int32)

Defines the contact email field id of the receiving media

culturestring

Defines the culture of the action

contentFormatinteger(int32)

Defines the email format to send

Enum12
useFormLinkSSLboolean

Defines a settings to apply ssl to NP6 form links

sendingProfileinteger or null(int32)

Defines the id of the sending profile to use

performanceobject

Defines the performance objectives of the action

mpobject

Defines the marketing pressure settings of the action

webAnalyserinteger or null(int32)

Defines the id of the webanalyser connector to use

archiveboolean or null

Archive settings

contentobject

Defines the content of the email action

headersobject

Defines headers of the email action

subjectstring

Defines the subject of the email action

htmlstring

Defines the HTML content of the email action

textstring

Defines the Text content of the email action

Response
application/json
{
  "type": "mailMessage",
  "id": "string",
  "name": "string",
  "description": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "informations": {
    "folder": 0,
    "category": 0,
    "state": 10
  },
  "settings": {
    "templating": {
      "version": "string"
    },
    "editionMode": 0,
    "purpose": {
      "type": "string"
    },
    "consent": 0,
    "priority": true,
    "importance": true,
    "environment": {},
    "field": 0,
    "culture": "string",
    "contentFormat": 1,
    "useFormLinkSSL": true,
    "sendingProfile": 0,
    "performance": {
      "openingRate": 0.1,
      "clickRate": 0.1,
      "unsubscribedRate": 0.1
    },
    "mp": {
      "use": true,
      "increment": true
    },
    "webAnalyser": 0,
    "archive": true
  },
  "content": {
    "headers": {
      "from": {
        "prefix": "string",
        "domain": "string",
        "label": "string"
      },
      "reply": "string"
    },
    "subject": "string",
    "html": "string",
    "text": "string"
  }
}

Delete an action

Request

Path
idstringrequired

The action's id to delete

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/actions/{id}' \
  -H 'X-Key: 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
© 2025 - ChapsVision - All Rights Reserved.