Assign or move a user ID

Assigns or moves a user ID to a cluster.

POST /1/clusters/mapping

curl

cURL

curl --request POST \
  --url https://algolia_application_id.algolia.net/1/clusters/mapping \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --header 'x-algolia-user-id: user1' \
  --data '
{
  "cluster": "c11-test"
}
'

200

{
  "createdAt": "2023-07-04T12:49:15Z"
}

The time it takes to move a user is proportional to the amount of data linked to the user ID.

Requires Admin API key

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Headers

X-Algolia-User-ID · string · required

Unique identifier of the user who makes the search request.

Pattern: ^[a-zA-Z0-9 \-*.]+$

Example:

"user1"

Body

application/json

Assign userID parameters.

cluster · string · required

Cluster name.

Example:

"c11-test"

Response

200

application/json

OK

Response and creation timestamp.

createdAt · string · required

Date and time when the object was created, in RFC 3339 format.

Example:

"2023-07-04T12:49:15Z"