API Reference / API Methods / MultiClusters / Remove userID

Feb. 26, 2019

Remove UserID

Required API Key: Admin

Method signature

$client->removeUserId(string userID)

client.remove_user_id(String userID)

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

client.remove_user_id(str userID)

This method is not yet available in the swift api client.

suspend fun ClientSearch.removeUserID(
    userID: UserID,
    requestOptions: RequestOptions? = null
): Deletion

This method is not yet available in the android api client.

client.RemoveUserID(string userID)

client.removeUserID(string userID)

client.RemoveUserID(string userID)

This method is not yet available in the scala api client.

See code examples

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

Copy

$client->removeUserId('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"

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

Copy
{
  "deletedAt": "2013-01-18T15:33:13.556Z"
}


          deletedAt

string

Date at which the indexing job has been created.

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

Remove UserID

About this method

Examples

Remove a userID and its associated data

Parameters

Response

JSON format

Did you find this page helpful?

On this page