Update the caller's locale override

POST 
/api/v1/enduser/update-locale

Sets a BCP-47 locale override for the caller, e.g. es-MX. This overrides the locale supplied by the identity provider.

Send an empty string to clear the override and fall back to the identity-provider locale.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Build an agent preferences screen

Request

Responses

200

Locale override updated

Set the authenticated end user’s locale override.

Section ID: DOC-CP-identity-access-api-updateLocale#example-end-users-updateLocale-request

Request example

{
  "locale": "en-US"
}

Guide request for 2. Save the user’s preferred language. Replace example resource identifiers with your own authorized values.

Section ID: DOC-CP-identity-access-api-updateLocale#example-cookbook-core-platform-identity-access-end-users-02-request

Request example

{
  "locale": "es-MX"
}

Guide request for 2. Save the user’s preferred language. Replace example resource identifiers with your own authorized values.

Section ID: DOC-CP-identity-access-api-updateLocale#example-cookbook-core-platform-identity-access-end-users-json-02-request

Request example

{
  "locale": ""
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.

Section ID: DOC-CP-identity-access-api-updateLocale#example-end-users-updateLocale-response

Response example

{}

Document ID: DOC-CP-identity-access-api-updateLocale. Section identities and revisions.

Section	Stable reference
Update the caller's locale override	DOC-CP-identity-access-api-updateLocale#overview
Request	DOC-CP-identity-access-api-updateLocale#request
Responses	DOC-CP-identity-access-api-updateLocale#responses