Delete a user profile

Deletes a user profile.

The response includes a date and time when the user profile can safely be considered deleted.

DELETE /1/profiles/{userToken}

curl

cURL

curl --request DELETE \
  --url https://personalization.us.algolia.com/1/profiles/test-user-123 \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "userToken": "test-user-123",
  "deletedUntil": "<string>"
}

Required ACL: recommendation

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

userToken · string · required

Unique identifier representing a user for which to fetch the personalization profile. Unique pseudonymous or anonymous user identifier.

This helps with analytics and click and conversion events. For more information, see user token.

Example:

"test-user-123"

Response

200

application/json

OK

userToken · string · required

Unique pseudonymous or anonymous user identifier.

This helps with analytics and click and conversion events. For more information, see user token.

Example:

"test-user-123"

deletedUntil · string · required

Date and time when the user profile can be safely considered to be deleted. Any events received after the deletedUntil date start a new user profile.