Remove UserID
$client->removeUserId(string userID)
About this method
You are currently reading the JavaScript API client v4 documentation. Check our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.
You are currently reading the Ruby API client v2 documentation. Check our 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
Remove a userID and its associated data
1
$client->removeUserId('myUserID1');
Parameters
userID
|
type: string
Required
userID to delete. |
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"
}
deletedAt
|
string
Date at which the indexing job has been created. |