End¶
https://{cluster-id}.api.esales.apptus.cloud/api/v2/notifications/end
POST¶
Deprecated
This endpoint is part of an API that has been deprecated and its end of life is 2024-04-20. All endpoints in this API version, including this, will be removed. Please upgrade to the latest version before 2024-04-20.
All API changes can be found here:
This endpoint will be replaced by end.
More information regarding the API versioning strategy can be found here.
To actively end a visitor session before it automatically times out, an end notification can be sent.
Request¶
Header parameters¶
Name | Description | Example |
---|---|---|
Accept-Encoding | Allows responses to be compressed using Gzip. | gzip |
Query parameters¶
Name | Description | Example |
---|---|---|
customerKey Required | A key that uniquely identifies the current visitor.Using UUIDs as keys are recommended | e3921377-18a2-47c9-a449-06b894898623 |
market Required | Must match the corresponding market identifier in the data feed. | UK |
sessionKey Required | A unique key, identifying the session.Using UUIDs as keys are recommended.Required | 0b05119e-eeb8-418a-bbfb-defa0dde417e |
curl -i \
-X POST \
-H 'Accept-Encoding: gzip' \
"https://{cluster-id}.api.esales.apptus.cloud/api/v2/notifications/end?customerKey=e3921377-18a2-47c9-a449-06b894898623&market=UK&sessionKey=0b05119e-eeb8-418a-bbfb-defa0dde417e"
Response¶
Response codes¶
Status | Description |
---|---|
204 | Notification was received successfully. |
400 | Invalid or missing required arguments. |
500 | Server error such as cluster unavailable or busy. The response body may contain more information about the error. |