Api clients / JavaScript / V3 / Methods

Assign or Move UserID | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

Required API Key: Admin
Method signature 
client.assignUserID(
  {
    userID: string,
    cluster: string
  },
  callback
);

See code examples

About this method

Assign or Move a userID to a cluster.

The time it takes to migrate (move) a user is proportional to the amount of data linked to the userID.

Examples

Assign a user to a cluster

Copy
Copy 
1

$client->assignUserId('myUserID1', 'c1-test');

Parameters

userID
type: string
Required

userID to assign.

If userID is unknown, we will assign the userID to the cluster, otherwise the operation will move the userID and its associated data from its current cluster to the new one specified in parameter 2.

If you have already called this method, and it is still running, you will not be able to run this method again for the same userID, until the first has finished. Any attempt will be rejected. it will be rejected.

The userID can contain:

  • alphanumeric caracters
  • -
  • .
  •   (space)
  • *
clusterName
type: string
Required

Cluster name.

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
1
2
3

{
  "createdAt": "2013-01-18T15:33:13.556Z"
}
createdAt
string

Date at which the indexing job has been created.

Did you find this page helpful?