Skip to content

End Notification

To end a visitor session, an end notification is to be sent to Apptus eSales. The level of personalisation affects the actions performed when a session ends.

Method

POST

URL format

/api/v1/notifications/end

Parameters

Name Type Description Example
sessionKey string A unique id. UUID / GUID 2F75A...EAFA6
customerKey string Visitor id. SHA256 hash if the visitor is signed in, otherwise a UUID / GUID. 5G7HJ...R77T1
market string Visitor Market Sweden
token string Unique token generated by the CustomerKeyAuthentication class. Should only be set for signed in visitors. EAFA6...2F75A

Request body

{
    "sessionKey": "string",
    "customerKey": "string",
    "market": "string",
    "token": "string"
}

Request content-type

application/json

Response content-type

HTTP response code

Responses

Response Description
204 Notifications was received successfully.
403 A SHA256 customer key was used, but it could not be validated.
5xx Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Examples

Try out the API at the Apptus API Playground with your eSales Playground and API credentials.

Request

request-body.json

{
    "sessionKey": "b106299c-eac0-4f6f-96d2-93e57c255784",
    "customerKey": "d9528030-509c-4e0f-b585-7168f1e9feca",
    "market": "UK"
}

cURL

#!/bin/bash
curl -i \
-X POST \
-d @request-body.json \
-H "Content-Type: application/json" \
 "https://{cluster-id}.api.esales.apptus.cloud/api/v1/notifications/end"

Response

HTTP/1.1 204 No Content
×