Skip to content
/
Retrieve the specified ca...

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

Campaign

Operations

Create a campaign

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

Data used to create the campaign

idstring(uuid)

Defines the id of the campaign

namestring

Defines the name of the campaign

descriptionstring

Defines the description of the campaign

startDatestring(date-time)

The start date of the campaign

endDatestring(date-time)

The end date of the campaign

creationDatestring(date-time)

The creation date of the campaign

updateDatestring(date-time)

The update date of the campaign

itemsArray of objects

Defines the items of the campaign

typestring
Discriminator
idinteger(int32)

Defines the id of the item

curl -i -X POST \
  https://api-cm.np6.com/campaigns \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "creationDate": "2019-08-24T14:15:22Z",
    "updateDate": "2019-08-24T14:15:22Z",
    "items": [
      {
        "type": "string"
      }
    ]
  }'

Responses

The created campaign

Bodyapplication/json
idstring(uuid)

Defines the id of the campaign

namestring

Defines the name of the campaign

descriptionstring

Defines the description of the campaign

startDatestring(date-time)

The start date of the campaign

endDatestring(date-time)

The end date of the campaign

creationDatestring(date-time)

The creation date of the campaign

updateDatestring(date-time)

The update date of the campaign

itemsArray of objects

Defines the items of the campaign

typestring
Discriminator
idinteger(int32)

Defines the id of the item

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "creationDate": "2019-08-24T14:15:22Z",
  "updateDate": "2019-08-24T14:15:22Z",
  "items": [
    {
      "type": "string"
    }
  ]
}

Retrieve the specified campaign

Request

Path
idstringrequired

The campaign'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 GET \
  'https://api-cm.np6.com/campaigns/{id}' \
  -H 'X-Key: string'

Responses

A campaign

Bodyapplication/json
idstring(uuid)

Defines the id of the campaign

namestring

Defines the name of the campaign

descriptionstring

Defines the description of the campaign

startDatestring(date-time)

The start date of the campaign

endDatestring(date-time)

The end date of the campaign

creationDatestring(date-time)

The creation date of the campaign

updateDatestring(date-time)

The update date of the campaign

itemsArray of objects

Defines the items of the campaign

typestring
Discriminator
idinteger(int32)

Defines the id of the item

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "creationDate": "2019-08-24T14:15:22Z",
  "updateDate": "2019-08-24T14:15:22Z",
  "items": [
    {
      "type": "string"
    }
  ]
}

Update a campaign

Request

Path
idstringrequired

The campaign'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 campaign

idstring(uuid)

Defines the id of the campaign

namestring

Defines the name of the campaign

descriptionstring

Defines the description of the campaign

startDatestring(date-time)

The start date of the campaign

endDatestring(date-time)

The end date of the campaign

creationDatestring(date-time)

The creation date of the campaign

updateDatestring(date-time)

The update date of the campaign

itemsArray of objects

Defines the items of the campaign

typestring
Discriminator
idinteger(int32)

Defines the id of the item

curl -i -X PUT \
  'https://api-cm.np6.com/campaigns/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "creationDate": "2019-08-24T14:15:22Z",
    "updateDate": "2019-08-24T14:15:22Z",
    "items": [
      {
        "type": "string"
      }
    ]
  }'

Responses

The updated campaign

Bodyapplication/json
idstring(uuid)

Defines the id of the campaign

namestring

Defines the name of the campaign

descriptionstring

Defines the description of the campaign

startDatestring(date-time)

The start date of the campaign

endDatestring(date-time)

The end date of the campaign

creationDatestring(date-time)

The creation date of the campaign

updateDatestring(date-time)

The update date of the campaign

itemsArray of objects

Defines the items of the campaign

typestring
Discriminator
idinteger(int32)

Defines the id of the item

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "creationDate": "2019-08-24T14:15:22Z",
  "updateDate": "2019-08-24T14:15:22Z",
  "items": [
    {
      "type": "string"
    }
  ]
}

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.