Skip to content
/
Update capping of the spe...

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

Notification

Operations

Archives

Operations

Email & SMS

Operations

Notification

Operations

Display

Operations

Email & SMS

Operations

Notification

Operations

Workflow

Operations

Retrieve nodes of the specified workflow

Request

Path
idinteger(int32)required

The workflow's id to retrieve nodes

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/scripting/workflows/{id}/capping' \
  -H 'X-Key: string'

Responses

An array of nodes

Bodyapplication/jsonArray [
keyobject

The key used to store incremental value

typestring
Discriminator
valueobject

A literal expression

incrementinteger(int32)

The value used to increment key value

thresholdinteger(int32)

The threshold used to handle capping decision

periodobject

The period used to handle capping decision

typestring
Discriminator
unitstring

The period unit

Enum"MILLISECOND""SECOND""MINUTE""HOUR""DAY""WEEK""MONTH""YEAR"
valueinteger(int32)

The period value

nodesArray of strings

the id of the workflow nodes to cap

]
Response
application/json
[
  {
    "key": {
      "type": "string"
    },
    "increment": 0,
    "threshold": 0,
    "period": {
      "type": "string"
    },
    "nodes": [
      "string"
    ]
  }
]

Update capping of the specified workflow

Request

Path
idinteger(int32)required

Defines the workflow's id to update capping

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 capping of the workflow

Array [
keyobject

The key used to store incremental value

typestring
Discriminator
valueobject

A literal expression

incrementinteger(int32)

The value used to increment key value

thresholdinteger(int32)

The threshold used to handle capping decision

periodobject

The period used to handle capping decision

typestring
Discriminator
unitstring

The period unit

Enum"MILLISECOND""SECOND""MINUTE""HOUR""DAY""WEEK""MONTH""YEAR"
valueinteger(int32)

The period value

nodesArray of strings

the id of the workflow nodes to cap

]
curl -i -X PUT \
  'https://api-cm.np6.com/scripting/workflows/{id}/capping' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '[
    {
      "key": {
        "type": "string"
      },
      "increment": 0,
      "threshold": 0,
      "period": {
        "type": "string"
      },
      "nodes": [
        "string"
      ]
    }
  ]'

Responses

An array of updated capping

Bodyapplication/jsonArray [
keyobject

The key used to store incremental value

typestring
Discriminator
valueobject

A literal expression

incrementinteger(int32)

The value used to increment key value

thresholdinteger(int32)

The threshold used to handle capping decision

periodobject

The period used to handle capping decision

typestring
Discriminator
unitstring

The period unit

Enum"MILLISECOND""SECOND""MINUTE""HOUR""DAY""WEEK""MONTH""YEAR"
valueinteger(int32)

The period value

nodesArray of strings

the id of the workflow nodes to cap

]
Response
application/json
[
  {
    "key": {
      "type": "string"
    },
    "increment": 0,
    "threshold": 0,
    "period": {
      "type": "string"
    },
    "nodes": [
      "string"
    ]
  }
]

Delete capping of the specified workflow

Request

Path
idinteger(int32)required

Defines the workflow's id to delete capping

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/scripting/workflows/{id}/capping' \
  -H 'X-Key: string'

Responses

No Content

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.