Skip to content

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

Campaign

Operations

Contact

Operations

Field

Operations

Enumeration

Operations

Segment

Operations

Import

Operations

Retrieve all import definitionsDeprecated

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

Responses

Bodyapplication/vnd.mperf.v8.import.v1+jsonArray [
idinteger or null(int32)

Import Id

namestring

Import name

creationDatestring(date-time)

Import creation date

updateDatestring or null(date-time)

Import update date

bindinginteger or null(int32)

Id of the import format that describes the mapping between import file columns and fields

featuresArray of objects

Import configuration features

typestring
Discriminator
segmentIdinteger(int32)

The id of the segment to add imported targets to

emptyExisitingSegmentboolean

If true, empty the segment before adding the targets

sourceobject

Data source use to import the targets

typestring
Discriminator
idinteger or null(int32)

The identifier of the source

creationDatestring(date-time)

The creation date

updateDatestring or null(date-time)

The update date

filenamestring

The name of the file

dataArray of objects

The content of the file

]
Response
application/vnd.mperf.v8.import.v1+json
[
  {
    "id": 23,
    "name": "Import Contacts",
    "creationDate": "2023-03-01T11:04:00Z",
    "binding": 44,
    "features": [
      {
        "type": "report",
        "sendFinalReport": true,
        "sendErrorReport": true,
        "contactGuids": [
          "1C0193AB"
        ]
      },
      {
        "type": "database",
        "updateExisting": true,
        "crushData": false
      },
      {
        "type": "duplicate",
        "rules": {
          "first": true
        }
      },
      {
        "type": "segmentation",
        "segmentId": 501,
        "emptyExisitingSegment": false
      },
      {
        "type": "normalization",
        "fields": {
          "233": [
            "FRA",
            "ESP"
          ]
        }
      }
    ],
    "source": {
      "type": "ftp",
      "creationDate": "0001-01-01T00:00:00Z",
      "folder": "23 - Import Contacts",
      "templateFilename": "Import Contacts.csv"
    },
    "scheduler": {
      "id": 79
    }
  },
  {
    "id": 24,
    "name": "Import Redlist",
    "creationDate": "2023-03-01T11:34:00Z",
    "binding": 45,
    "features": [
      {
        "type": "report",
        "sendFinalReport": true,
        "sendErrorReport": true,
        "contactGuids": [
          "1C0193AB"
        ]
      },
      {
        "type": "database",
        "updateExisting": true,
        "crushData": false
      },
      {
        "type": "duplicate",
        "rules": {
          "first": true
        }
      },
      {
        "type": "redList",
        "destination": {
          "mail": true,
          "sms": false
        }
      }
    ],
    "source": {
      "type": "ftp",
      "creationDate": "0001-01-01T00:00:00Z",
      "folder": "24 - Import Redlist",
      "templateFilename": "Import Redlist.csv"
    },
    "scheduler": {
      "id": 80
    }
  }
]

Create an import definitionDeprecated

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

The import definition to create

idinteger or null(int32)

Import Id

namestring

Import name

creationDatestring(date-time)

Import creation date

updateDatestring or null(date-time)

Import update date

bindinginteger or null(int32)

Id of the import format that describes the mapping between import file columns and fields

featuresArray of objects

Import configuration features

typestring
Discriminator
segmentIdinteger(int32)

The id of the segment to add imported targets to

emptyExisitingSegmentboolean

If true, empty the segment before adding the targets

sourceobject

Data source use to import the targets

typestring
Discriminator
idinteger or null(int32)

The identifier of the source

creationDatestring(date-time)

The creation date

updateDatestring or null(date-time)

The update date

filenamestring

The name of the file

dataArray of objects

The content of the file

schedulerobject

The scheduler information

typestring
Discriminator
idinteger(int32)

Scheduler Id

namestring

Scheduler name

creationDatestring(date-time)

Scheduler creation date

descriptionstring

Scheduler description

enabledboolean or null

True if scheduler is enabled

timezonestring

Microsoft Timezone identifier, e.g.: (UTC+01:00) Brussels, Copenhagen, Madrid, Paris

extensionobject

Extra data

valueobject

One time execution time

curl -i -X POST \
  https://api-cm.np6.com/imports \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "id": null,
    "name": "Import Contacts",
    "creationDate": "0001-01-01T00:00:00Z",
    "binding": 44,
    "features": [
      {
        "type": "report",
        "sendFinalReport": true,
        "sendErrorReport": true,
        "contactGuids": [
          "1C0193AB"
        ]
      },
      {
        "type": "database",
        "updateExisting": true,
        "crushData": false
      },
      {
        "type": "duplicate",
        "rules": {
          "first": true
        }
      },
      {
        "type": "segmentation",
        "segmentId": 501,
        "emptyExisitingSegment": false
      },
      {
        "type": "normalization",
        "fields": {
          "233": [
            "FRA",
            "ESP"
          ]
        }
      }
    ],
    "source": {
      "type": "ftp",
      "creationDate": "0001-01-01T00:00:00Z",
      "folder": "23 - Import Contacts",
      "templateFilename": "Import Contacts.csv"
    },
    "scheduler": {
      "type": "periodic",
      "id": 0,
      "name": null,
      "enabled": null,
      "timezone": null,
      "frequency": {
        "occurs": {
          "type": "weekly",
          "interval": 1,
          "days": [
            "Sun"
          ]
        },
        "periodicity": {
          "type": "once",
          "value": {
            "hour": 6,
            "minute": 0,
            "second": 0
          }
        }
      },
      "validity": null
    }
  }'

Responses

Bodyapplication/vnd.mperf.v8.import.v1+json
idinteger or null(int32)

Import Id

namestring

Import name

creationDatestring(date-time)

Import creation date

updateDatestring or null(date-time)

Import update date

bindinginteger or null(int32)

Id of the import format that describes the mapping between import file columns and fields

featuresArray of objects

Import configuration features

typestring
Discriminator
segmentIdinteger(int32)

The id of the segment to add imported targets to

emptyExisitingSegmentboolean

If true, empty the segment before adding the targets

sourceobject

Data source use to import the targets

typestring
Discriminator
idinteger or null(int32)

The identifier of the source

creationDatestring(date-time)

The creation date

updateDatestring or null(date-time)

The update date

filenamestring

The name of the file

dataArray of objects

The content of the file

schedulerobject

The scheduler information

typestring
Discriminator
idinteger(int32)

Scheduler Id

namestring

Scheduler name

creationDatestring(date-time)

Scheduler creation date

descriptionstring

Scheduler description

enabledboolean or null

True if scheduler is enabled

timezonestring

Microsoft Timezone identifier, e.g.: (UTC+01:00) Brussels, Copenhagen, Madrid, Paris

extensionobject

Extra data

valueobject

One time execution time

Response
application/vnd.mperf.v8.import.v1+json
{
  "id": 23,
  "name": "Import Contacts",
  "creationDate": "2023-03-01T11:04:00Z",
  "binding": 44,
  "features": [
    {
      "type": "report",
      "sendFinalReport": true,
      "sendErrorReport": true,
      "contactGuids": [
        "1C0193AB"
      ]
    },
    {
      "type": "database",
      "updateExisting": true,
      "crushData": false
    },
    {
      "type": "duplicate",
      "rules": {
        "first": true
      }
    },
    {
      "type": "segmentation",
      "segmentId": 501,
      "emptyExisitingSegment": false
    },
    {
      "type": "normalization",
      "fields": {
        "233": [
          "FRA",
          "ESP"
        ]
      }
    }
  ],
  "source": {
    "type": "ftp",
    "creationDate": "0001-01-01T00:00:00Z",
    "folder": "23 - Import Contacts",
    "templateFilename": "Import Contacts.csv"
  },
  "scheduler": {
    "type": "periodic",
    "id": 79,
    "name": "New schedule",
    "creationDate": "2023-03-01T11:04:00Z",
    "enabled": true,
    "timezone": "(Utc+01:00) Brussels, Copenhagen, Madrid, Paris",
    "frequency": {
      "occurs": {
        "type": "weekly",
        "interval": 1,
        "days": [
          "Sun"
        ]
      },
      "periodicity": {
        "type": "once",
        "value": {
          "hour": 6,
          "minute": 0,
          "second": 0
        }
      }
    },
    "validity": {
      "start": {
        "hour": 11,
        "minute": 4,
        "second": 0,
        "year": 2023,
        "month": 3,
        "date": 1
      }
    }
  }
}

Retrieve the specified import definitionDeprecated

Request

Path
idinteger(int32)required

The import definition'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/imports/{id}' \
  -H 'X-Key: string'

Responses

Bodyapplication/vnd.mperf.v8.import.v1+json
idinteger or null(int32)

Import Id

namestring

Import name

creationDatestring(date-time)

Import creation date

updateDatestring or null(date-time)

Import update date

bindinginteger or null(int32)

Id of the import format that describes the mapping between import file columns and fields

featuresArray of objects

Import configuration features

typestring
Discriminator
segmentIdinteger(int32)

The id of the segment to add imported targets to

emptyExisitingSegmentboolean

If true, empty the segment before adding the targets

sourceobject

Data source use to import the targets

typestring
Discriminator
idinteger or null(int32)

The identifier of the source

creationDatestring(date-time)

The creation date

updateDatestring or null(date-time)

The update date

filenamestring

The name of the file

dataArray of objects

The content of the file

schedulerobject

The scheduler information

idinteger(int32)

The identifier

Response
application/vnd.mperf.v8.import.v1+json
{
  "id": 23,
  "name": "Import Contacts",
  "creationDate": "2023-03-01T11:04:00Z",
  "binding": 44,
  "features": [
    {
      "type": "report",
      "sendFinalReport": true,
      "sendErrorReport": true,
      "contactGuids": [
        "1C0193AB"
      ]
    },
    {
      "type": "database",
      "updateExisting": true,
      "crushData": false
    },
    {
      "type": "duplicate",
      "rules": {
        "first": true
      }
    },
    {
      "type": "segmentation",
      "segmentId": 501,
      "emptyExisitingSegment": false
    },
    {
      "type": "normalization",
      "fields": {
        "233": [
          "FRA",
          "ESP"
        ]
      }
    }
  ],
  "source": {
    "type": "ftp",
    "creationDate": "0001-01-01T00:00:00Z",
    "folder": "23 - Import Contacts",
    "templateFilename": "Import Contacts.csv"
  },
  "scheduler": {
    "id": 79
  }
}

Subscription

Operations

Contact

Operations

Webtask

Operations

Compilable

Operations

Mobile Application

Operations

Category

Operations

Marketing Pressure

Operations
© 2025 - ChapsVision - All Rights Reserved.