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

About this method # A

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 # A

Remove a userID and its associated data#

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

Parameters # A

userID #
type: string
Required

userID to delete.

Response # A

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?
PHP v3