Mass update custom attributes
Set custom attribute with PUT HTTP request for users in bulk.
PUT
/users/mass_update_custom_attributes/
Data
Type
Description
ids
list
List of users' id (integers).
attribute
string
The name of your attribute. Has to be at least 1 character, and cannot be longer than 255 characters.
value
various types
Type can be boolean, integer, date, string or date & time.
curl -X POST -H "Authorization: Token <your_64_char_api_key>" -H "Content-Type: application/json" -d '{
"ids": [10, 15, 22, 23],
"attribute": "Name of the attribute",
"value": "Value for the attribute"
}' "https://<your_app_subdomain>.user.com/api/public/users/mass_update_custom_attributes/"
var settings = {
"async": true,
"crossDomain": true,
"url": "https://<your_app_subdomain>.user.com/api/public/users/mass_update_custom_attributes/",
"method": "POST",
"headers": {
"authorization": "Token <your_64_char_api_key>",
"content-type": "application/json"
},
"processData": false,
"data": "{\n \"ids\": [2, 5, 10, 21,22],\n \"attribute\": \"Name of the attribute\",\n \"value\": \"Value for the attribute\"\n}"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
var data = JSON.stringify({
"ids": [2, 5, 10, 21,22],
"attribute": "Name of the attribute",
"value": "Value for the attribute"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://<your_app_subdomain>.user.com/api/public/users/mass_update_custom_attributes/");
xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");
xhr.setRequestHeader("content-type", "application/json");
xhr.send(data);
var request = require("request");
var options = { method: 'POST',
url: 'https://<your_app_subdomain>.user.com/api/public/users/mass_update_custom_attributes/',
headers:
{ 'content-type': 'application/json',
authorization: 'Token <your_64_char_api_key>' },
body:
{ ids: [2, 5, 10, 21,22],
attribute: 'Name of the attribute',
value: 'Value for the attribute' },
json: true };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://<your_app_subdomain>.user.com/api/public/users/mass_update_custom_attributes/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\n \"ids\": [2, 5, 10, 21,22],\n \"attribute\": \"Name of the attribute\",\n \"value\": \"Value for the attribute\"\n}",
CURLOPT_HTTPHEADER => array(
"authorization: Token <your_64_char_api_key>",
"content-type: application/json"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
import requests
url = "https://<your_app_subdomain>.user.com/api/public/users/mass_update_custom_attributes/"
payload = "{\n \"ids\": [2, 5, 10, 21,22],\n \"attribute\": \"Name of the attribute\",\n \"value\": \"Value for the attribute\"\n}"
headers = {
'authorization': "Token <your_64_char_api_key>",
'content-type': "application/json"
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
import http.client
conn = http.client.HTTPSConnection("<your_app_subdomain>.user.com")
payload = "{\n \"ids\": [2, 5, 10, 21,22],\n \"attribute\": \"Name of the attribute\",\n \"value\": \"Value for the attribute\"\n}"
headers = {
'authorization': "Token <your_64_char_api_key>",
'content-type': "application/json"
}
conn.request("POST", "/api/public/users/mass_update_custom_attributes/", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))