Remove Recent Searches¶

https://{cluster-id}.api.esales.apptus.cloud/api/v2/notifications/remove-recent-searches

POST¶

Deprecated

This endpoint is part of an API that has been deprecated and its end of life is 2024-04-30. All endpoints in this API version, including this, will be removed. Please upgrade to the latest version before 2024-04-30.

All API changes can be found here:

This endpoint will be replaced by remove-recent-searches.

More information regarding the API versioning strategy can be found here.

The remove recent searches notification is to be sent when a visitor wants to clear recent search phrases.

Request¶

Header parameters¶

Name	Description	Example
Accept-Encoding	Allows responses to be compressed using Gzip.	`gzip`

Supported Content-Type¶

application/json;charset=utf-8
text/plain;charset=utf-8

Request body¶

Example

application/json;charset=utf-8

{
  "phrases" : [ "test phrase to remove" ],
  "removeAll" : true
}

Schema

RemoveRecentSearchesNotification¶

The remove recent searches notification should be sent when a visitor (specified by "customerKey") wishes to remove recently searched phrases.

Name	Type	Description	Example
phrases	string[]	Array with recent search phrases to remove. Optional if property "removeAll" is true.	`test phrase to remove`
removeAll	boolean	Whether all recent search phrases should be removed. Optional and defaults to false if property "phrases" is provided.

curl -i \
-X POST \
-H 'Accept-Encoding: gzip' \
-H 'Content-Type: application/json;charset=utf-8' \
"https://{cluster-id}.api.esales.apptus.cloud/api/v2/notifications/remove-recent-searches" \
-T request-body.file

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.