---
title: "Update account settings"
method: PATCH
path: "/account"
tags: ["Account"]
---

# Update account settings

`PATCH /account`

Update account settings, such as welcome email content, IP address restrictions, webhooks settings and secure password requirements.

**Notes**

- You must have [admin-level access](/docs/account/04-users/00-introduction#managing-user-roles-and-permissions) to change account settings.

## Headers

- `ev-api-key` string, required
- `ev-access-token` string, required

## Request body

- object
  - `secureOnly` boolean — Whether unencrypted FTP connections should be denied for the account.
  - `complexPasswords` boolean — Whether to require complex passwords for all passwords.
  - `showReferralLinks` boolean — Whether to display links for others to sign up on share views and invitation emails
  - `externalDomain` string — Custom address used for web file manager. Not available for all account types.
  - `emailContent` string — Content of welcome email template.
  - `emailSubject` string — Subject line for welcome emails
  - `allowedIpRanges` object[] — IP Address Ranges for restricting account access
    - `ipStart` string, ipv4
    - `ipEnd` string, ipv4
  - `brandingSettings` object
    - `companyName` string — Custom company name to include in copyright and title bar.
    - `customEmail` string, email — Address to use as sender of email messages generated by ExaVault
    - `theme` string — Color scheme for web file manager. Valid options are **default**, **light** and **dark**
  - `accountOnboarding` boolean — Whether extra help popups can be enabled for users in the web file manager.
  - `customSignature` string — Signature to be automatically added to the bottom of emails generated by the account.
  - `quota` object
    - `noticeEnabled` boolean — Whether the system should email the account owner if the account storage exceeds the noticeThreshold value. Storage notice emails are sent no mo once per day.
    - `noticeThreshold` integer — Percent of account storage that would trigger a notice email. Must be a whole number between 70 and 100 (inclusive).
    - `transactionsNoticeEnabled` boolean — Whether the system should email the account owner if the daily transaction usage exceeds the transactionsNoticeThreshold value. Transaction notice emails are sent no more than once per day.
    - `transactionsNoticeThreshold` integer — Percent of daily transaction usage that would trigger a notice email. Must be a whole number between 70 and 100 (inclusive).

## Response `200`

Successful operation

- AccountResponse
  - `responseStatus` integer
  - `data` Account — Object contains all account properties.
    - `id` integer — Account ID
    - `type` 'account' — Type of item. "account"
    - `attributes` AccountAttributes — unresolved $ref
    - `relationships` object
      - `masterUser` object
        - `data` object
          - `type` 'user'
          - `id` integer — ID of master user for account
  - `included` User[] — Array can contain objects specified in include param of the get call e.g User object
    - `id` integer — ID of the user.
    - `type` string — Type of object being returned. Always "user"
    - `attributes` UserAttributes — Attributes of the user including expiration, home directory, and permissions.
      - `status` 0 | 1, required — Indicates user activity status. `0` means the user is locked and cannot log in. `1` means the user is active and can log in.
      - `locked` boolean — `true` if the user is locked and cannot log in.
      - `expiration` string — Timestamp of user expiration.
      - `created` string, date-time, required — Timestamp of user creation.
      - `modified` string, date-time, required — Timestamp of user modification.
      - `accessTimestamp` string — Timestamp of most recent successful user login.
      - `accountName` string, required — Name of the account this user belongs to.
      - `username` string, required — Username of the user.
      - `nickname` string, required — Nickname of the user.
      - `email` string — Email address of the user.
      - `homePath` string — Path to the user's home folder.
      - `permissions` UserPermissions, required
        - `download` boolean, required — Download permission flag
        - `upload` boolean, required — Upload permission flag
        - `modify` boolean, required — Modify permission flag
        - `delete` boolean, required — Delete permission flag
        - `list` boolean, required — View folder contents permission flag
        - `changePassword` boolean, required — Change (own) password permission flag
        - `share` boolean, required — Sharing permission flag
        - `notification` boolean, required — Notifications permission flag
        - `viewFormData` boolean, required — Access Form Data permission flag. If true, user can view submissions that have been stored for a receive folder. This includes any data submitted in the receive folder form.
        - `deleteFormData` boolean, required — Delete form data permission flag. If true, user can remove data that was submitted for a receive folder. This applies only to data submitted in the receive folder form, not the actual files uploaded.
      - `role` 'user' | 'admin' | 'master', required — User's access level
      - `timeZone` string, required — User's timezone. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values.
      - `onboarding` boolean, required — Whether the onboarding help system is enabled for this user. `true` means that additional help popups are displayed in the web application for this user.
      - `firstLogin` boolean — `true` if the user has logged into the system.
    - `relationships` object — Home resource and owner account relationship data for the user.
      - `homeResource` object
        - `data` object
          - `type` 'resource' — Type is resource.
          - `id` integer — ID of home directory resource.
      - `ownerAccount` object, required
        - `data` object
          - `type` 'account' — Type is account.
          - `id` integer — ID of the account.

---

[API](https://skmtc.net/prismic/apis/exavault-api.md) · [All operations](https://skmtc.net/prismic/apis/exavault-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/prismic/exavault-api/revisions/a1bd874b5960/schema)