Delete visitor profile API reference

You can use an API to delete visitor profiles that are logged with Sitecore Search. To help you use this API, refer to Using an API to delete a visitor profile, which states the prerequisites and includes a sample request and response.

API URL and methods

The API accepts application/JSON, exposes one endpoint, and supports one method:

DELETE https://api.rfksrv.com/user/v1/users-history/<domainID>?ids=<ID1,ID2>

Data model and parameters

Here's the data model of this API:

RequestResponse
{
  "method": "DELETE",
  "url": "https://api.rfksrv.com/user/v1/users-history/<domainID>?ids=<comma-separated visitor identifiers>
  "headers": {
    "Authorization": "API key or access token"
  }
}

The API has the following URL parameters:

Key

Type

Description

domainID

String

Required.

Numeric domain identifier. To see your domainID, click the domain name drop-down menu in Search.

Example: 673223107

ids

String

Required.

Unique identifiers of the visitors whose profiles you want to delete. You can pass any of the following unique visitor identifiers you previously sent Search, as specified in the Events API model and Search and Recommendation API model:

  • uuid

  • user_id

  • cuid

  • eid

  • fbid

  • email

To delete multiple visitor profiles in a single request, pass IDs separated with commas. You can mix ID types.

For example, to delete three visitor profiles, you can pass:

sample_user_id,jane.doe%40company.com,sample_fbid

request_id

String

Optional.

Identifier for this request that you can use for internal tracking. Pass any unique string.

If you do not pass a request_id, Search generates one for you if the request is successful.

The API has the following header parameters:

Key

Type

Description

Authorization

String

Required.

API key or access token with the user scope. You can get this value from the Developer Resources section of Search.

Example: 01-6425ce111-3999a6a12b3dfc6b9371857beeadf31897269c8a

The API has the following response parameters:

Key

Type

Description

request_id

String

Unique identifier for this request. You see this if the response was successful.

If you pass a request_id in the request, you see that ID in the response.

If you don't pass a request_id in the request, you see a Search-generated ID in the response.

Example: hsn1255sd652gDFdii0827

If the request fails, you'll see an error code and error message.

Do you have some feedback for us?

If you have suggestions for improving this article,