Save user preferences

Updates the authenticated user's profile preferences.

Reference

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

Updates the authenticated user's profile preferences. Accepts a JSON body with any combination of profile fields: email, phone, firstName, lastName, websiteUrl, company, state, accountUIStyle, and comments. Only non-null fields in the request body are applied (partial update). If a 'password' object is included (with current, password, and confirm sub-fields), the password is changed after verifying the current password matches. Requires authentication. The updated preference object is returned in the response.

Body

A JSON body. An example, built from the field definitions:

{
  "userId": "101",
  "username": "john.doe",
  "email": "john.doe@example.com",
  "phone": "+1 (555) 123-4567"
}

Responses

200

User preferences saved successfully. Response includes the updated 'preference' object.

400

Bad request — invalid or missing parameters

401

Unauthorized — authentication error

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/save.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "userId": "101",
  "username": "john.doe",
  "email": "john.doe@example.com",
  "phone": "+1 (555) 123-4567"
}'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/save.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json={
    "userId": "101",
    "username": "john.doe",
    "email": "john.doe@example.com",
    "phone": "+1 (555) 123-4567"
})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/save.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "userId": "101",
    "username": "john.doe",
    "email": "john.doe@example.com",
    "phone": "+1 (555) 123-4567"
  }),
});

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-preference/save.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"userId\":\"101\",\"username\":\"john.doe\",\"email\":\"john.doe@example.com\",\"phone\":\"+1 (555) 123-4567\"}"))
    .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-preference/save.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("{\"userId\":\"101\",\"username\":\"john.doe\",\"email\":\"john.doe@example.com\",\"phone\":\"+1 (555) 123-4567\"}", Encoding.UTF8, "application/json");

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-preference/save.do", strings.NewReader(`{"userId":"101","username":"john.doe","email":"john.doe@example.com","phone":"+1 (555) 123-4567"}`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")

	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-preference/save.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/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"userId":"101","username":"john.doe","email":"john.doe@example.com","phone":"+1 (555) 123-4567"}');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/save.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "{\"userId\":\"101\",\"username\":\"john.doe\",\"email\":\"john.doe@example.com\",\"phone\":\"+1 (555) 123-4567\"}"

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