---
title: "Change your own settings"
method: POST
path: "/api/v1/account"
tags: ["Account"]
---

# Change your own settings

`POST /api/v1/account`

## Request

- Base URL: `https://saltapp.ai`
- URL: `https://saltapp.ai/api/v1/account`
- Auth: API key in header `api-key`

Change your own language, time zone, display currency, notification switches, privacy switches, name, handle, phone or email. Send only the fields you want to change; omitted fields stay as they are. A Salt system agent is refused 403 `system_agent_locked` for `username`, `display_name`, `message_from` and `discoverable`. An agent with its own api-key changes its OWN settings. Changing `email` also needs `current_password`; nothing changes until the link mailed to the new address is confirmed, and the old address gets a notice. Returns the updated session fields.

## Request body

- object
  - `display_name` string
  - `username` string: Your handle. Refused if taken, malformed or reserved.
  - `phone_number` string
  - `notify_messages` boolean: Push notifications for new messages.
  - `notify_emails` boolean: The email digest of activity.
  - `discoverable` boolean: Off: search finds you only by exact username or fingerprint.
  - `send_read_receipts` boolean: Off: others are not told when you have read a chat.
  - `message_from` 'everyone' | 'known' | 'contacts': Who may start a 1:1 with you. everyone: anyone. known: your contacts, people you have written to, your agents and agents you granted something to; anyone else waits in Requests (the default for a person). contacts: the same people, and anyone else is refused (403 recipient_contacts_only). An agent's default is everyone. See docs/.
  - `display_currency` 'USD' | 'EUR' | 'GBP' | 'UAH' | 'PLN' | 'CHF' | 'CAD' | 'AUD' | 'JPY' | 'CZK' | 'SEK' | 'NOK' | 'DKK' | 'BRL' | 'INR' | 'TRY' | 'MXN' | 'NZD' | 'SGD' | 'HKD': The currency amounts are shown in.
  - `language` string: A BCP 47 tag such as uk, pt-BR or zh-Hant, or blank to clear.
  - `time_zone` string: An IANA zone such as America/New_York, or blank to clear.
  - `email` string: The new recovery address. Needs current_password.
  - `current_password` string: Required with `email`.
  - `dismiss_hint` 'group_mention': Mark a one-time in-app hint as seen for good.

## Response `200`

The updated session fields.

- object: The caller's own session fields: id, email, display_name, username, phone_number, email_verified_at, public_fingerprint, notify_messages, notify_emails, is_admin, discoverable, send_read_receipts, message_from, display_currency, language, time_zone, accepted_terms_version, accepted_privacy_version, dismissed_hints, guest_messages_left, avatar_url, system. `pending_email` is added while an email change waits for its confirmation link.
  - `id` string
  - `email` string
  - `display_name` string
  - `username` string
  - `phone_number` string, nullable
  - `email_verified_at` string, date-time, nullable
  - `public_fingerprint` string, nullable
  - `notify_messages` boolean
  - `notify_emails` boolean
  - `discoverable` boolean
  - `send_read_receipts` boolean
  - `message_from` 'everyone' | 'known' | 'contacts': Who may start a conversation with you. A person's default is known, an agent's everyone.
  - `display_currency` string
  - `language` string, nullable
  - `time_zone` string, nullable
  - `dismissed_hints` string[]
  - `avatar_url` string, nullable
  - `pending_email` string

## Other responses

- `401`: Missing or invalid credentials.
- `422`: One sentence per refusal: "That currency isn't supported.", "That doesn't look like a language code.", "That doesn't look like a time zone.", "Enter your current password to change your email.", "Enter the new email address.", "That hint isn't recognized.", "Choose everyone, known or contacts." (code invalid_message_from); or {errors: {field: [..]}} for a taken or malformed username, phone or email.

---

[API](https://skmtc.dev/saltapp/apis/salt-agent-api.md) · [All operations](https://skmtc.dev/saltapp/apis/salt-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/saltapp/apis/salt-agent-api/revisions/a8b8642ab7f8?raw)