---
title: "Update a sub-account"
method: POST
path: "/sub-accounts/{sub_account_id}"
---

# Update a sub-account

`POST /sub-accounts/{sub_account_id}`

## Request

- Base URL: `https://app.fullenrich.com/api/v2`
- URL: `https://app.fullenrich.com/api/v2/sub-accounts/{sub_account_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation/docs/sub-accounts/:sub_account_id/post.ts> (a function with typed inputs; its response is checked against the schema)

Rename, archive, or restore a sub-account. Provide at least one of name or archived. This workspace-level management request must not include the Sub-Account-ID header.

## Request body

- union: Provide at least one property.
  - object
    - `name` string, required: A new unique name for the sub-account. Leading and trailing whitespace is removed before storage.
    - `archived` boolean: Set to true to archive the sub-account or false to restore it.
  - object
    - `name` string: A new unique name for the sub-account. Leading and trailing whitespace is removed before storage.
    - `archived` boolean, required: Set to true to archive the sub-account or false to restore it.

## Response `200`

OK

- SubAccount
  - `id` string, uuid, required: The sub-account ID. Use this value in the Sub-Account-ID header for scoped API calls.
  - `workspace_id` string, uuid, required: The ID of the workspace that owns the sub-account.
  - `name` string, required: The sub-account name.
  - `archived` boolean, required: Whether the sub-account is archived.
  - `created_at` string, date-time, required: When the sub-account was created.
  - `updated_at` string, date-time, required: When the sub-account was last updated.

## Other responses

- `400`: Invalid sub-account ID, request body, or name
- `401`: Unauthorized
- `403`: Sub-account management requires the direct workspace scope
- `404`: Sub-account not found
- `409`: A sub-account with this name already exists
- `429`: Too Many Requests

## Changes

- **2026-11-05** `9e5fe5ba0794`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation/changes/sub-accounts/:sub_account_id/post.md)

---

[API](https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation.md) - [All operations](https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation/revisions/b5bec9933c01?raw)