/

Browse the help center

Update user info

Updates the profile information of a specified user.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/user/update.do

Updates the profile information of a specified user. Only admin-role users can call this endpoint. The fields to update are provided as form parameters (login, password, firstName, lastName, email, phone, country, state, company, websiteUrl, active, receiveNewsletter, receiveNotificationsByEmail, role, adsHost, referer, uiStyle, comments, aiChatMonthlyLimitUsd). Only non-null fields are applied; null fields are left unchanged, except aiChatMonthlyLimitUsd, which an empty value clears. The login and email must be unique across the system. Role changes are validated against the caller's manageable roles. A country code or role id that does not exist is reported in errors.country / errors.role and nothing is saved.

Form Params

usernameToUpdate string required

Username (login) of the target user whose profile should be updated. The user must exist in the system

john.doe

active boolean

Whether the user account is active

true

adsHost string

Ad serving host domain

ads.example.com

aiChatMonthlyLimitUsd string

The user's monthly AI assistant budget in billed USD, 0 to 1000000. Send it empty to clear it, so the network default applies; leave it out to keep the current value.

50

comments string

Admin comments about the user

VIP client, priority support

company string

Company name

Acme Inc.

country string

Two-letter country code (ISO 3166-1 alpha-2)

US

email string

User email address

john@example.com

firstName string

First name

John

lastName string

User's last (family) name

Doe

login string

User login name (username)

john.doe

password string

User password (8-64 characters)

s3cur3P@ss

phone string

Phone number

+1 (555) 123-4567

receiveNewsletter boolean

Whether the user receives newsletters

true

receiveNotificationsByEmail boolean

Whether the user receives notifications by email

true

referer string

Referrer URL or identifier

https://partner.com

role integer

User role ID

3

state string

State or region name

California

uiStyle string

UI style preference

TREES

websiteUrl string

Website URL

https://example.com

Responses

200

Operation result with success status

400

Bad request — invalid or missing parameters

401

Authentication error

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/user/update.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'usernameToUpdate=john.doe' \
  --data-urlencode 'active=true' \
  --data-urlencode 'adsHost=ads.example.com' \
  --data-urlencode 'aiChatMonthlyLimitUsd=50'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/user/update.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"usernameToUpdate": "john.doe", "active": "true", "adsHost": "ads.example.com", "aiChatMonthlyLimitUsd": "50"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/user/update.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"usernameToUpdate":"john.doe","active":"true","adsHost":"ads.example.com","aiChatMonthlyLimitUsd":"50"}),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/user/update.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("usernameToUpdate=john.doe&active=true&adsHost=ads.example.com&aiChatMonthlyLimitUsd=50"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/user/update.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["usernameToUpdate"] = "john.doe", ["active"] = "true", ["adsHost"] = "ads.example.com", ["aiChatMonthlyLimitUsd"] = "50" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/user/update.do", strings.NewReader(`usernameToUpdate=john.doe&active=true&adsHost=ads.example.com&aiChatMonthlyLimitUsd=50`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/user/update.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'usernameToUpdate=john.doe&active=true&adsHost=ads.example.com&aiChatMonthlyLimitUsd=50');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/user/update.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('usernameToUpdate' => "john.doe", 'active' => "true", 'adsHost' => "ads.example.com", 'aiChatMonthlyLimitUsd' => "50")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body