Remove UserID | JavaScript API Client V3 (Deprecated)

client.removeUserID({ userID: string }, callback)

About this method

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

Remove a userID and its associated data

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

1
client.remove_user_id('myUserID1')

1
2
3
4
5
client.removeUserID({ userID: 'myUserID1' }, (err, content) => {
  if (err) throw err;

  console.log(content);
});

1
res = client.remove_user_id('myUserID1')

1
2
3
4
var res = client.RemoveUserID("myUserID1");

// Asynchronous
var res = await client.RemoveUserIDAsync("myUserID1");

1
2
3
4
DeleteUserID res = client.removeUserID("myUserID1");

// Asynchronous
CompletableFuture<DeleteUserID> res = client.removeUserIDAsync("myUserID1");

1
res, err := client.RemoveUserID("myUserID1")

1
2
3
client.execute {
  remove userID "myUserID1"
}

$
$
$
$
$
curl -X DELETE \
     -H "X-Algolia-USER-ID: ${USER_ID}" \
     -H "X-Algolia-API-Key: ${API_KEY}" \
     -H "X-Algolia-Application-Id: ${APPLICATION_ID}" \
    "https://${APPLICATION_ID}.algolia.net/1/clusters/mapping"

1
client.removeUserID(UserID("myUserID1"))

Parameters

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

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