Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
The remove recent searches notification is to be sent when a visitor wants to clear recent search phrases.
POST https://{cluster-id}.elevate-api.cloud/api/storefront/v3/notifications/remove-recent-searches
Request header parameters
| Name | Description | Example |
|---|---|---|
Accept-Encoding | Allows responses to be compressed using Gzip. | gzip |
Request query parameters
| Name | Description | Example |
|---|---|---|
customerKey* | A key that uniquely identifies the current visitor. Using UUIDs as keys are recommended This field is required unless userContext is set to ANONYMOUS or UNPERSONALIZED in which case it is not allowed.If userContext is set to ‘SYNTHETIC’ this is optional. | e3921377-18a2-47c9-a449-06b894898623 |
market* | Must match the corresponding market identifier in the data feed. | UK |
sessionKey* | A unique key, identifying the session. Using UUIDs as keys are recommended. This field is required unless userContext is set to ANONYMOUS in which case it is not allowed.If userContext is set to SYNTHETIC this is optional. | 0b05119e-eeb8-418a-bbfb-defa0dde417e |
userContext | Specifies the level of consent for data tracking. If omitted, the request will be treated as if PERSONALIZED is used. See user context for more details. Supported values: PERSONALIZED, UNPERSONALIZED, ANONYMOUS, SYNTHETIC. | PERSONALIZED |
Request body example
{
"phrases" : [ "test phrase to remove" ],
"removeAll" : true
}
Request body schema
| Name | Type | Description |
|---|---|---|
| phrases | string[] | Array with recent search phrases to remove. Optional if property “removeAll” is true. Examples: "test phrase to remove" |
| removeAll | boolean | Whether all recent search phrases should be removed. Optional and defaults to false if property “phrases” is provided. |
Example request
curl -i \
-X POST \
-H 'Accept-Encoding: null' \
-H 'Content-Type: application/json;charset=utf-8' \
"https://{cluster-id}.elevate-api.cloud/api/storefront/v3/notifications/remove-recent-searches?customerKey=customerKey&market=market&sessionKey=sessionKey&userContext=userContext" \
-T request-body.file
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. |
202 | Notification was received successfully, but persisting the change is taking longer than expected. Future requests can show stale data, but the change should be persisted eventually. |