End Notification

To end a visitor session, an end notification is to be sent to Apptus eSales Enterprise. 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
market string Visitor Market Sweden
customerKey string Visitor id. SHA256 hash if the visitor is signed in, otherwise a UUID / GUID. 5G7HJ...R77T1
sessionKey string A unique id. UUID / GUID. 2F75A...EAFA6
token string Unique token generated by the CustomerKeyAuthentication class. Should only be set for signed in visitors. EAFA6...2F75A

Request body

{
    "market": "string",
    "customerKey": "string",
    "sessionKey": "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

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

cURL

#!/bin/bash
curl -i \
-X POST \
-T 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
×
Copyright

This online publication is intellectual property of Apptus Technologies. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Apptus Technologies nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Apptus Technologies essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.

CLOSE