Marketing Pressure
/
Retrieve all rules

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

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

Set the mandatory topic option

Request

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

Value of the option

boolean
curl -i -X PUT \
  https://api-cm.np6.com/settings/marketing/pressure/topic \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{}'

Responses

The value of the mandatory topic option

Bodyapplication/json
boolean
Response
application/json
true

Retrieve all rules

Request

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/marketing/pressure/rules \
  -H 'X-Key: string'

Responses

A list of rules

Bodyapplication/jsonArray [
idstring(uuid)

Defines the id of the rule

labelstring

Defines the name of the rule

predicateobject

Defines the name of the rule

typestring
Discriminator
expressionsArray of objects

Defines the list of expression a logical operator could apply on

stampobject

Defines the stamp informations of the rule (creation and modification date)

creationstring(date-time)

Defines a date, used to store the creation date of a related data

modificationstring(date-time)

Defines a date, used to store the last modification date of a related data

createdBystring

Defines the creator by their identity

modifiedBystring

Defines the modifier by their identity

enabledboolean

Defines if the rule is enabled or not

]
Response
application/json
[
  {
    "id": "aae42f42-3759-4e80-94c5-e47daab1489b",
    "label": "1 communication a day for Black friday topic",
    "predicate": {
      "type": "rule",
      "limit": 1,
      "media": [
        "sms",
        "email"
      ],
      "period": {
        "rolling": false,
        "value": 1,
        "unit": "day"
      },
      "topics": [
        "aae42f42-3759-4e80-94c5-e47daab1487b"
      ]
    },
    "stamp": {
      "creation": "2025-04-01T12:40:45.763Z",
      "modification": "2025-04-01T12:40:45.763Z"
    },
    "createdBy": "Connected user",
    "modifiedBy": "Connected user",
    "enabled": true
  },
  {
    "id": "bae42f42-3759-4e80-94c5-e47daab1487c",
    "label": "10 communications/15 days",
    "predicate": {
      "type": "rule",
      "limit": 10,
      "media": [
        "email"
      ],
      "period": {
        "rolling": true,
        "value": 15,
        "unit": "day"
      }
    },
    "stamp": {
      "creation": "2025-04-01T12:40:45.764Z",
      "modification": "2025-04-01T12:40:45.764Z"
    },
    "createdBy": "Connected user",
    "modifiedBy": "Connected user",
    "enabled": true
  }
]

Retrieve the specified rule

Request

Path
idstringrequired

The rule'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/marketing/pressure/rules/{id}' \
  -H 'X-Key: string'

Responses

The rule

Bodyapplication/json
idstring(uuid)

Defines the id of the rule

labelstring

Defines the name of the rule

predicateobject

Defines the name of the rule

typestring
Discriminator
expressionsArray of objects

Defines the list of expression a logical operator could apply on

stampobject

Defines the stamp informations of the rule (creation and modification date)

creationstring(date-time)

Defines a date, used to store the creation date of a related data

modificationstring(date-time)

Defines a date, used to store the last modification date of a related data

createdBystring

Defines the creator by their identity

modifiedBystring

Defines the modifier by their identity

enabledboolean

Defines if the rule is enabled or not

Response
application/json
{
  "id": "aae42f42-3759-4e80-94c5-e47daab1489b",
  "label": "1 communication a day for Black friday topic",
  "predicate": {
    "type": "rule",
    "limit": 1,
    "media": [
      "sms",
      "email"
    ],
    "period": {
      "rolling": false,
      "value": 1,
      "unit": "day"
    },
    "topics": [
      "aae42f42-3759-4e80-94c5-e47daab1487b"
    ]
  },
  "stamp": {
    "creation": "2025-04-01T12:40:45.786Z",
    "modification": "2025-04-01T12:40:45.786Z"
  },
  "createdBy": "Connected user",
  "modifiedBy": "Connected user",
  "enabled": true
}
© 2025 - ChapsVision - All Rights Reserved.