Update own profile

Reference

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

Changes the authenticated user's own profile the way the console's Preferences page does: firstName, lastName, phone, company, websiteUrl, country, state, accountUIStyle, advancedAnalyticsView, locale, darkTheme, compactMode, receiveNewsletter and receiveNotificationsByEmail. Send a JSON body with only the fields to change; a field left out keeps its value, and an empty string clears phone, company, websiteUrl, country or state. Password, e-mail, API key and role are never changed here — a body property this operation does not know is listed in 'ignoredFields' with its reason in 'ignoredFieldReasons' instead of being applied. 'locale' is accepted only when the network lets signed-in users change the interface language. Returns the resulting profile in 'preference', shaped as by user-preference/get.

Body

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

{
  "firstName": "Olivia",
  "lastName": "Bennett",
  "phone": "+1 (555) 123-4567",
  "company": "Northwind Media"
}

Responses

200

Profile saved

400

Body is not valid JSON, a value has the wrong type, or a field is invalid (per-field 'errors'; e.g. a country code that is not in the country list)

401

Unauthorized — authentication error

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/update-profile.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "firstName": "Olivia",
  "lastName": "Bennett",
  "phone": "+1 (555) 123-4567",
  "company": "Northwind Media"
}'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/update-profile.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json={
    "firstName": "Olivia",
    "lastName": "Bennett",
    "phone": "+1 (555) 123-4567",
    "company": "Northwind Media"
})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/update-profile.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "firstName": "Olivia",
    "lastName": "Bennett",
    "phone": "+1 (555) 123-4567",
    "company": "Northwind Media"
  }),
});

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/update-profile.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"firstName\":\"Olivia\",\"lastName\":\"Bennett\",\"phone\":\"+1 (555) 123-4567\",\"company\":\"Northwind Media\"}"))
    .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/update-profile.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("{\"firstName\":\"Olivia\",\"lastName\":\"Bennett\",\"phone\":\"+1 (555) 123-4567\",\"company\":\"Northwind Media\"}", 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/update-profile.do", strings.NewReader(`{"firstName":"Olivia","lastName":"Bennett","phone":"+1 (555) 123-4567","company":"Northwind Media"}`))
	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/update-profile.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, '{"firstName":"Olivia","lastName":"Bennett","phone":"+1 (555) 123-4567","company":"Northwind Media"}');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/update-profile.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "{\"firstName\":\"Olivia\",\"lastName\":\"Bennett\",\"phone\":\"+1 (555) 123-4567\",\"company\":\"Northwind Media\"}"

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