Update user profile

PUT

/api/v1/users/{id}/profile

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "http://127.0.0.1:58259/api/v1/users/1/profile");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{ \"name\": \"example\", \"email\": \"example\", \"locale\": \"example\", \"theme\": \"example\", \"themeAccent\": \"example\", \"themeSyncEnabled\": true }");

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("http://127.0.0.1:58259/api/v1/users/1/profile"),
    Content = new StringContent("{ \"name\": \"example\", \"email\": \"example\", \"locale\": \"example\", \"theme\": \"example\", \"themeAccent\": \"example\", \"themeSyncEnabled\": true }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

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

func main() {

  url := "http://127.0.0.1:58259/api/v1/users/1/profile"

  payload := strings.NewReader("{ \"name\": \"example\", \"email\": \"example\", \"locale\": \"example\", \"theme\": \"example\", \"themeAccent\": \"example\", \"themeSyncEnabled\": true }")

  req, _ := http.NewRequest("PUT", url, payload)

  req.Header.Add("Content-Type", "application/json")

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

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("http://127.0.0.1:58259/api/v1/users/1/profile"))
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{ \"name\": \"example\", \"email\": \"example\", \"locale\": \"example\", \"theme\": \"example\", \"themeAccent\": \"example\", \"themeSyncEnabled\": true }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"name\": \"example\", \"email\": \"example\", \"locale\": \"example\", \"theme\": \"example\", \"themeAccent\": \"example\", \"themeSyncEnabled\": true }");
Request request = new Request.Builder()
  .url("http://127.0.0.1:58259/api/v1/users/1/profile")
  .put(body)
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'PUT',
  url: 'http://127.0.0.1:58259/api/v1/users/1/profile',
  headers: {'Content-Type': 'application/json'},
  data: {
    name: 'example',
    email: 'example',
    locale: 'example',
    theme: 'example',
    themeAccent: 'example',
    themeSyncEnabled: true
  }
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'http://127.0.0.1:58259/api/v1/users/1/profile';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"example","email":"example","locale":"example","theme":"example","themeAccent":"example","themeSyncEnabled":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{ \"name\": \"example\", \"email\": \"example\", \"locale\": \"example\", \"theme\": \"example\", \"themeAccent\": \"example\", \"themeSyncEnabled\": true }")
val request = Request.Builder()
  .url("http://127.0.0.1:58259/api/v1/users/1/profile")
  .put(body)
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

use std::str::FromStr;
use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "http://127.0.0.1:58259/api/v1/users/1/profile";

    let payload = json!({
        "name": "example",
        "email": "example",
        "locale": "example",
        "theme": "example",
        "themeAccent": "example",
        "themeSyncEnabled": true
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request PUT \
  --url http://127.0.0.1:58259/api/v1/users/1/profile \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "email": "example", "locale": "example", "theme": "example", "themeAccent": "example", "themeSyncEnabled": true }'

wget --quiet \
  --method PUT \
  --header 'Content-Type: application/json' \
  --body-data '{ "name": "example", "email": "example", "locale": "example", "theme": "example", "themeAccent": "example", "themeSyncEnabled": true }' \
  --output-document \
  - http://127.0.0.1:58259/api/v1/users/1/profile

Update a user’s profile preferences by their ID. Allowed for admins and the user themself.

Parameters

Path Parameters

required

integer format: int64

ID of the user

Request Body^required

application/json

User profile update request

object

name

string

email

string

locale

string

theme

string

themeAccent

string

themeSyncEnabled

boolean

Example ^generated

{
  "name": "example",
  "email": "example",
  "locale": "example",
  "theme": "example",
  "themeAccent": "example",
  "themeSyncEnabled": true
}

Responses

200

User profile updated successfully

*/*

object

integer format: int64

username

string

name

string

email

string

locale

string

theme

string

themeAccent

string

themeSyncEnabled

boolean

provisioningMethod

string

Allowed values: LOCAL OIDC REMOTE

assignedLibraries

Array<object>

object

integer format: int64

name

string

sort

object

field

string

direction

string

Allowed values: ASCENDING DESCENDING

icon

string

iconType

string

Allowed values: PRIME_NG CUSTOM_SVG

fileNamingPattern

string

watch

boolean

paths

Array<object>

object

integer format: int64

libraryId

integer format: int64

path

string

formatPriority

Array<string>

Allowed values: PDF EPUB CBX FB2 MOBI AZW3 AUDIOBOOK

allowedFormats

Array<string>

Allowed values: PDF EPUB CBX FB2 MOBI AZW3 AUDIOBOOK

organizationMode

string

Allowed values: BOOK_PER_FILE BOOK_PER_FOLDER AUTO_DETECT

metadataSource

string

Allowed values: EMBEDDED SIDECAR PREFER_SIDECAR PREFER_EMBEDDED NONE

permissions

object

canUpload

boolean

canDownload

boolean

canEditMetadata

boolean

canManageLibrary

boolean

canSyncKoReader

boolean

canSyncKobo

boolean

canEmailBook

boolean

canDeleteBook

boolean

canAccessOpds

boolean

canManageMetadataConfig

boolean

canAccessBookdrop

boolean

canAccessLibraryStats

boolean

canAccessUserStats

boolean

canAccessTaskManager

boolean

canManageGlobalPreferences

boolean

canManageIcons

boolean

canManageFonts

boolean

canBulkAutoFetchMetadata

boolean

canBulkCustomFetchMetadata

boolean

canBulkEditMetadata

boolean

canBulkRegenerateCover

boolean

canMoveOrganizeFiles

boolean

canBulkLockUnlockMetadata

boolean

canBulkResetBookloreReadProgress

boolean

canBulkResetKoReaderReadProgress

boolean

canBulkResetBookReadStatus

boolean

demoUser

boolean

admin

boolean

userSettings

object

perBookSetting

object

pdf

string

Allowed values: Global Individual

epub

string

Allowed values: Global Individual

cbx

string

Allowed values: Global Individual

newPdf

string

Allowed values: Global Individual

pdfReaderSetting

object

pageSpread

string

pageZoom

string

scrollLayout

string

newPdfReaderSetting

object

pageSpread

string

Allowed values: EVEN ODD

pageViewMode

string

Allowed values: SINGLE_PAGE TWO_PAGE

backgroundColor

string

Allowed values: GRAY BLACK WHITE

fitMode

string

Allowed values: ACTUAL_SIZE FIT_PAGE FIT_WIDTH FIT_HEIGHT AUTO

scrollMode

string

Allowed values: PAGINATED INFINITE

epubReaderSetting

object

theme

string

font

string

fontSize

integer format: int32

letterSpacing

number format: float

lineHeight

number format: float

flow

string

spread

string

ebookReaderSetting

object

fontFamily

string

fontSize

integer format: int32

gap

number format: float

hyphenate

boolean

isDark

boolean

justify

boolean

lineHeight

number format: float

maxBlockSize

integer format: int32

maxColumnCount

integer format: int32

maxInlineSize

integer format: int32

theme

string

flow

string

cbxReaderSetting

object

pageSpread

string

Allowed values: EVEN ODD

pageViewMode

string

Allowed values: SINGLE_PAGE TWO_PAGE

fitMode

string

Allowed values: ACTUAL_SIZE FIT_PAGE FIT_WIDTH FIT_HEIGHT AUTO

scrollMode

string

Allowed values: PAGINATED INFINITE LONG_STRIP

backgroundColor

string

Allowed values: GRAY BLACK WHITE

stripMaxWidthPercent

integer format: int32

sidebarLibrarySorting

object

field

string

order

string

sidebarShelfSorting

object

field

string

order

string

sidebarMagicShelfSorting

object

field

string

order

string

entityViewPreferences

object

global

object

sortKey

string

sortDir

string

sortCriteria

Array<object>

object

field

string

direction

string

view

string

coverSize

number format: float

seriesCollapsed

boolean

overlayBookType

boolean

overrides

Array<object>

object

entityType

string

entityId

integer format: int64

preferences

object

sortKey

string

sortDir

string

sortCriteria

Array<object>

object

field

string

direction

string

view

string

seriesCollapsed

boolean

overlayBookType

boolean

coverSize

number format: float

tableColumnPreference

Array<object>

object

field

string

visible

boolean

order

integer format: int32

filterMode

string

filterSortingMode

string

metadataCenterViewMode

string

koReaderEnabled

boolean

enableSeriesView

boolean

autoSaveMetadata

boolean

visibleFilters

Array<string>

visibleSortFields

Array<string>

dashboardConfig

object

scrollers

Array<object>

object

string

type

string

title

string

enabled

boolean

order

integer format: int32

maxItems

integer format: int32

magicShelfId

integer format: int64

sortField

string

sortDirection

string

defaultPassword

boolean

Update user profile

Parameters

Path Parameters

Request Body required

Example generated

Responses

200

Request Body^required

Example ^generated