Skip to main content
POST
/
1
/
clusters
/
mapping
/
batch
curl
curl --request POST \
  --url https://algolia_application_id.algolia.net/1/clusters/mapping/batch \
  --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","users":["einstein","bohr","feynman"]}'
{
  "createdAt": "2023-07-04T12:49:15Z"
}
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.

Example:

"user1"

Body

application/json

Assign userID parameters.

​
cluster
string
required

Cluster name.

Example:

"c11-test"

​
users
string[]
required

User IDs to assign.

Example:
["einstein", "bohr", "feynman"]

Response

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"

⌘I