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.
- Retrieve the specified import definition
Retrieve all import definitions
Create an import definition
Update an existing import definition
Delete an import definition
Upload a new file for an import with a binary request
Get the last execution state of an import
Start a new execution for an import
Can update the import with the request model
Retrieve the specified im...
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
Bodyapplication/json
The import definition to create
Id of the import format that describes the mapping between import file columns and fields
Import configuration features
Data source use to import the targets
The scheduler information
- Production serverhttps://api-cm.np6.com/imports
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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
}
}'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 } } } }
- Production serverhttps://api-cm.np6.com/imports/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-cm.np6.com/imports/{id}' \
-H 'X-Key: string'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 } }
Bodyapplication/json
The update of the import definition
Id of the import format that describes the mapping between import file columns and fields
Import configuration features
Data source use to import the targets
The scheduler information
- Production serverhttps://api-cm.np6.com/imports/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-cm.np6.com/imports/{id}' \
-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": false,
"sendErrorReport": true,
"contactGuids": [
"1C0193AB"
]
},
{
"type": "database",
"updateExisting": true,
"crushData": false
},
{
"type": "segmentation",
"segmentId": 501,
"emptyExisitingSegment": true
}
]
}'Response
application/vnd.mperf.v8.import.v1+json
{ "id": 23, "name": "Import Contacts", "creationDate": "2023-03-01T11:04:00Z", "updateDate": "2023-03-01T12:04:00Z", "binding": 44, "features": [ { "type": "report", "sendFinalReport": false, "sendErrorReport": true, "contactGuids": [ "1C0193AB" ] }, { "type": "database", "updateExisting": true, "crushData": false }, { "type": "duplicate", "rules": { "first": true } }, { "type": "segmentation", "segmentId": 501, "emptyExisitingSegment": true }, { "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 } }