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.
Defines a start date filter
Specify this parameter to retrieve only events with a timestamp greater than or equal to the specified value
You can use an ISO format date or a timestamp
Defines an end date filter
Specify this parameter to retrieve only events with a timestamp less than the specified value
You can use an ISO format date or a timestamp
curl -i -X GET \
'https://api-cm.np6.com/actions/{id}/events/cancellations?end=2019-08-24T14%3A15%3A22Z&sort=asc&start=2019-08-24T14%3A15%3A22Z' \
-H 'X-Key: string'[ { "type": "cancellation", "id": "84b10b69-6761-434f-be85-d56ddfaf0f20", "timestamp": 1614089582000, "identity": { "type": "customer", "agency": "DEMO", "customer": "028" }, "source": { "type": "email", "detail": { "execution": { "id": "000PE4", "kind": "message", "recipient": { "type": "footprint", "id": "000R4M0T", "unicity": "example@np6.com", "hash": "0441619ab4631d18548aa8835dd2c28b" }, "data": { "foo": 1, "bar": 2 }, "stamp": { "time": 1614089576625, "id": "d52055cd-e854-4177-8ef5-b10fd8d568a7", "thread": "a3078b19-b379-4bc2-b29a-e8229a9c9332" } }, "cancellation": { "type": "user defined policy", "value": { "type": "render", "message": "Lorem ipsum dolor sit amet..." } } } } }, { "type": "cancellation", "id": "ed715f1b-cc57-43b8-9bbe-e18b58d7e38c", "timestamp": 1614089593000, "identity": { "type": "customer", "agency": "DEMO", "customer": "028" }, "source": { "type": "email", "detail": { "execution": { "id": "000PE4", "kind": "message", "recipient": { "type": "footprint", "id": "000R4M0T", "unicity": "example@np6.com", "hash": "0441619ab4631d18548aa8835dd2c28b" }, "stamp": { "time": 1614089576625, "id": "40e7f10f-9f96-4891-a340-bccc49b13155", "thread": "cbce7a1c-793e-45fb-baa1-5bfcb8998a36" } }, "cancellation": { "type": "redlisted target" } } } } ]
Defines a start date filter
Specify this parameter to retrieve only events with a timestamp greater than or equal to the specified value
You can use an ISO format date or a timestamp
Defines an end date filter
Specify this parameter to retrieve only events with a timestamp less than the specified value
You can use an ISO format date or a timestamp
curl -i -X GET \
'https://api-cm.np6.com/actions/{id}/events/bounces?end=2019-08-24T14%3A15%3A22Z&sort=asc&start=2019-08-24T14%3A15%3A22Z' \
-H 'X-Key: string'[ { "type": "bounce", "id": "968e9b7b-ca77-4795-9159-6e1af3566e18", "timestamp": 1614089582000, "identity": { "type": "customer", "agency": "DEMO", "customer": "028" }, "source": { "type": "email", "detail": { "activation": { "id": "000PE4", "kind": "message", "receiver": { "type": "id", "value": "0013KDC0" }, "stamp": { "time": 1614089576625, "id": "7bb105bd-e548-402b-bcd8-8fb30b5e6cf4", "thread": "98a5918d-b1c4-4dc6-9222-57719ccd5bc8" }, "recipient": "example@np6.com" }, "bounce": { "status": { "type": "sync", "code": { "enhanced": "5.4.4" }, "diagnostic": "unable to route: no mail hosts for domain", "mta": "" }, "analysis": { "verdict": "soft", "subject": { "type": "other or undefined status" } } } } } }, { "type": "bounce", "id": "14d3d192-bd40-4c0b-9048-4469ab3a981c", "timestamp": 1614089593000, "identity": { "type": "customer", "agency": "DEMO", "customer": "028" }, "source": { "type": "email", "detail": { "activation": { "id": "000PE4", "kind": "message", "receiver": { "type": "id", "value": "0013KDC8" }, "stamp": { "time": 1614089576625, "id": "4d3eb218-1887-4c43-b287-cac59acec5ea", "thread": "671d5989-3bdb-41fc-96c4-7acbdcb8de5e" }, "recipient": "example@blabla.com" }, "bounce": { "status": { "type": "sync", "code": { "enhanced": "5.1.2" }, "diagnostic": "bad destination system: no such domain", "mta": "" }, "analysis": { "verdict": "hard", "subject": { "type": "address", "detail": { "type": "bad destination system address" } } } } } } } ]
Defines a start date filter
Specify this parameter to retrieve only events with a timestamp greater than or equal to the specified value
You can use an ISO format date or a timestamp
Defines an end date filter
Specify this parameter to retrieve only events with a timestamp less than the specified value
You can use an ISO format date or a timestamp
curl -i -X GET \
'https://api-cm.np6.com/actions/{id}/events/responses/stop?end=2019-08-24T14%3A15%3A22Z&sort=asc&start=2019-08-24T14%3A15%3A22Z' \
-H 'X-Key: string'[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "timestamp": 0, "identity": { "type": "string" }, "source": { "type": "string" } } ]