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

Returns a cipher for a specified webtask with additional data

Request

Path
idinteger(int32)required

The webtask's id to get

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 POST \
  'https://api-cm.np6.com/scripting/webtasks/{id}/cipher' \
  -H 'X-Key: string'

Responses

A webtask

Bodyapplication/json
string
Response
application/json
"string"

Execute the specified webtask

Request

Path
idinteger(int32)required

The webtask's id to excute

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 execute the web task

schemestring
methodstring
headersArray of objects
keystring
valuestring
queryArray of objects
keystring
valuestring
parametersobject
contentobject
typestring
Discriminator
valueobject
curl -i -X POST \
  'https://api-cm.np6.com/scripting/webtasks/{id}/execution' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "scheme": "string",
    "method": "string",
    "headers": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "query": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "parameters": {},
    "content": {
      "type": "string"
    }
  }'

Responses

A Task

Bodyapplication/json
typestring
Discriminator
statusinteger(int32)
headersArray of objects
keystring
valuestring
contentobject
typestring
Discriminator
valueobject
Response
application/json
{ "type": "success", "status": 0, "headers": [ { "key": "string", "value": "string" } ], "content": { "type": "string" } }

Execute multiple webtasks

Request

Path
idinteger(int32)required

The webtask's id to excute

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 execute the web task

Array [
schemestring
methodstring
headersArray of objects
keystring
valuestring
queryArray of objects
keystring
valuestring
parametersobject
contentobject
typestring
Discriminator
valueobject
]
curl -i -X POST \
  'https://api-cm.np6.com/scripting/webtasks/{id}/executions' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '[
    {
      "scheme": "string",
      "method": "string",
      "headers": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "query": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "parameters": {},
      "content": {
        "type": "string"
      }
    }
  ]'

Responses

A Task

Bodyapplication/jsonArray [
typestring
Discriminator
statusinteger(int32)
headersArray of objects
keystring
valuestring
contentobject
typestring
Discriminator
valueobject
]
Response
application/json
[ { "type": "string" } ]

Compilable

Operations

Mobile Application

Operations

Category

Operations

Marketing Pressure

Operations