Set or clear the authenticated workspace user's personal interface locale.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Put, RequestUri = new Uri("https://example.com/api/workspace/account/preferred-locale"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"PreferredLocale\": \"example\" }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/account/preferred-locale';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"PreferredLocale":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/api/workspace/account/preferred-locale \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "PreferredLocale": "example" }'The personal locale applies to the user’s later requests: localized validation and business messages and Work Inbox texts. A null or empty value follows the workspace locale again.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Request payload to set or clear the personal interface locale of the authenticated workspace account.
object
Locale code en, uk, de, pl or es; null or empty follows the workspace locale.
Examplegenerated
{ "PreferredLocale": "example"}Request payload to set or clear the personal interface locale of the authenticated workspace account.
object
Locale code en, uk, de, pl or es; null or empty follows the workspace locale.
Examplegenerated
{ "PreferredLocale": "example"}Request payload to set or clear the personal interface locale of the authenticated workspace account.
object
Locale code en, uk, de, pl or es; null or empty follows the workspace locale.
Examplegenerated
{ "PreferredLocale": "example"}Responses
Section titled “Responses”OK
object
Profile fields for the authenticated workspace account.
object
Workspace user identifier.
Exact stored Unicode login name.
Optional email address.
First name.
Last name.
Canonical effective display name.
Avatar presentation values for a workspace user.
object
Initials derived from the user name.
Hex color for the avatar background.
Hex color for the avatar text.
Personal interface locale code (en, uk, de, pl or es); null follows the workspace locale.
Whether the account has a local password that can be changed with the current password.
Whether first and last name are managed by the associated Worker and are read-only here.
Display name of the identity provider that manages email and names, or null for a local account.
object
object
object
object
Example
{ "Data": { "UserType": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Profile fields for the authenticated workspace account.
object
Workspace user identifier.
Exact stored Unicode login name.
Optional email address.
First name.
Last name.
Canonical effective display name.
Avatar presentation values for a workspace user.
object
Initials derived from the user name.
Hex color for the avatar background.
Hex color for the avatar text.
Personal interface locale code (en, uk, de, pl or es); null follows the workspace locale.
Whether the account has a local password that can be changed with the current password.
Whether first and last name are managed by the associated Worker and are read-only here.
Display name of the identity provider that manages email and names, or null for a local account.
object
object
object
object
Example
{ "Data": { "UserType": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Profile fields for the authenticated workspace account.
object
Workspace user identifier.
Exact stored Unicode login name.
Optional email address.
First name.
Last name.
Canonical effective display name.
Avatar presentation values for a workspace user.
object
Initials derived from the user name.
Hex color for the avatar background.
Hex color for the avatar text.
Personal interface locale code (en, uk, de, pl or es); null follows the workspace locale.
Whether the account has a local password that can be changed with the current password.
Whether first and last name are managed by the associated Worker and are read-only here.
Display name of the identity provider that manages email and names, or null for a local account.
object
object
object
object
Example
{ "Data": { "UserType": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}