Apostra user preferences

Apostra user preferences are scoped to the authenticated user. They control the default language for new Apostra conversations and expose display preferences the UI can use when formatting Apostra surfaces.

These endpoints are available only when Apostra is enabled for the caller’s account.

Get preferences

GET /api/v2/murph/user-preferences Returns the caller’s current Apostra preferences. If the request is authenticated with a service token instead of a user session, the endpoint returns the same shape with all preference fields set to null.

curl

curl https://api.apostra.com/api/v2/murph/user-preferences \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

Response

{
  "preferredLanguage": "de",
  "locale": "de-DE",
  "timezone": "Europe/Berlin",
  "displayCurrency": "EUR"
}

Field	Type	Notes
`preferredLanguage`	enum \| null	User-level default language for new Apostra conversations. `null` means Apostra auto-detects language
`locale`	string \| null	BCP-47 display locale, such as `en-US`, `de-DE`, or `ja-JP`
`timezone`	string \| null	IANA timezone, such as `America/New_York` or `Europe/Berlin`
`displayCurrency`	string \| null	ISO 4217 currency code used for display formatting, such as `USD`, `EUR`, or `JPY`

Set default language

PUT /api/v2/murph/user-preferences/language Sets the caller’s user-level default Apostra language. New conversations inherit this value at creation time. Existing conversations keep their own language override unless you update them separately. Send preferredLanguage: null to clear the user default and return new conversations to auto-detect.

curl

curl -X PUT https://api.apostra.com/api/v2/murph/user-preferences/language \
  -H "Authorization: Bearer $SCOPE3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "preferredLanguage": "fr"
  }'

Request body

Field	Type	Required	Notes
`preferredLanguage`	enum \| null	Yes	Supported Apostra language code, or `null` to clear the default

Response

{
  "preferredLanguage": "fr",
  "locale": "fr-FR",
  "timezone": null,
  "displayCurrency": null
}

The response returns the full preference object now in effect.

Supported languages

Code	Language
`en`	English
`de`	German
`fr`	French
`es`	Spanish
`pt`	Portuguese
`it`	Italian
`nl`	Dutch
`sv`	Swedish
`pl`	Polish
`ja`	Japanese
`ko`	Korean
`zh`	Chinese, Simplified
`ar`	Arabic
`hi`	Hindi
`tr`	Turkish

Errors

400 VALIDATION_ERROR — invalid request body, unsupported language code, invalid locale, invalid timezone, or invalid currency.
400 BAD_REQUEST — setting a user-level default was attempted from a non-user auth context.
401 UNAUTHORIZED — missing or invalid bearer token.
403 FORBIDDEN — Apostra is not enabled for the caller’s account.

See Errors for the full error contract.

Ask Apostra

How storefront operators use Apostra in the platform.

Apostra confirmations

Confirmation flows for Apostra actions that need approval.

Start here

Buy media

Sell media

Help and updates

Apostra user preferences

Get preferences

Response

Set default language

Request body

Response

Supported languages

Errors

Ask Apostra

Apostra confirmations

​Get preferences

​Response

​Set default language

​Request body

​Response

​Supported languages

​Errors

​Related

Ask Apostra

Apostra confirmations

Get preferences

Response

Set default language

Request body

Response

Supported languages

Errors

Related