API Reference / API Methods / MultiClusters / Remove userID
Required API Key: Admin
Method signature
$client->removeUserId(string userID)

About this method

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

Remove a userID and its associated data from the multi-clusters.

Even if the userID doesn’t exist, the request to remove the userID will still succeed because of the asynchronous handling of this request.

Examples

Read the Algolia CLI documentation for more information.

Remove a userID and its associated data

1
$client->removeUserId('myUserID1');

Parameters

userID
type: string
Required

userID to delete.

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format

1
2
3
{
  "deletedAt": "2013-01-18T15:33:13.556Z"
}
deletedAt
string

Date at which the indexing job has been created.

Did you find this page helpful?