---
title: "Update account by ID"
method: PATCH
path: "/accounts/{account_id}"
tags: ["Accounts"]
---

# Update account by ID

`PATCH /accounts/{account_id}`

Updates the account specified by its ID.

## Request body

- object
  - `name` string — The name of the account.

## Response `200`

Account updated.

- union
  - object
    - `id` string, uuid, required — Account unique identifier.
    - `created_at` string, date-time, required — Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
    - `updated_at` string, date-time, required — Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
    - `account_group_id` string, uuid, required — Account group unique identifier.
    - `type` 'TRADING' | 'PORTFOLIO', required — Account type. * TRADING - Orders in accounts of this type are created on a specific instrument basis. * PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available.
    - `users` object[], required
      - `id` string, uuid — User unique identifier.
      - `type` 'OWNER' | 'GUARDIAN' | 'CHILD' — Relation type * OWNER - Account Group Owner * CHILD - Child Account Group Owner * GUARDIAN - Child Account Group Guardian
    - `account_number` integer, required — The serial account number of the account in the account group.
    - `name` string, required — The name of the account.
    - `status` 'PENDING_APPROVAL' | 'ACTIVE' | 'CLOSING' | 'CLOSED' | 'LOCKED', required — The status of the account * PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on. * ACTIVE - Account is active - full functionality of the Investment API is accessible. * CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed. * CLOSED - Account is closed with zero balance successfully. * LOCKED - Account is locked for all actions.
  - object
    - `id` string, uuid, required — Account unique identifier.
    - `created_at` string, date-time, required — Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
    - `updated_at` string, date-time, required — Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
    - `account_group_id` string, uuid, required — Account group unique identifier.
    - `type` 'TRADING' | 'PORTFOLIO', required — Account type. * TRADING - Orders in accounts of this type are created on a specific instrument basis. * PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available.
    - `business_id` string, uuid, required — Unique identifier for the business.
    - `account_number` integer, required — The serial account number of the account in the account group.
    - `name` string, required — The name of the account.
    - `status` 'PENDING_APPROVAL' | 'ACTIVE' | 'CLOSING' | 'CLOSED' | 'LOCKED', required — The status of the account * PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on. * ACTIVE - Account is active - full functionality of the Investment API is accessible. * CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed. * CLOSED - Account is closed with zero balance successfully. * LOCKED - Account is locked for all actions.

## Other responses

- `400` — Bad Request. The incoming request had a malformed parameter/object.
- `401` — Unauthorized. The caller has not been authenticated.
- `403` — Forbidden. The caller has been authenticated but is not allowed to take the requested action.
- `404` — Not Found. The requested resource could not be found.
- `406` — Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
- `429` — Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
- `500` — Internal Server Error. The service encountered an unexpected error.
- `503` — Service Unavailable. The service handling for this request cannot be reached at this time.
- `504` — Gateway Timeout. The service gateway has reached its internal timeout.

---

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