# Set your name

URL: https://heaven.dev/docs/reference/account/name
Updated: 2026-11-21

Set or clear the display name on your sign-in identity.

`POST /v1/account/modify`

## Parameters

- `name` (string): Display name, up to 100 bytes.
- `clear` (boolean): Clear the display name.

## Returns

- `data` (object, always present): Your display name after saving it.
  - `name` (string | null, always present): Saved display name.

## Errors

Each code is explained in full at https://heaven.dev/docs/reference/errors.

| Code | Status | What happened |
|---|---:|---|
| `invalid` | 400 | An input is missing or invalid. |
| `unauthenticated` | 401 | The credential is missing, invalid, expired or revoked. |
| `denied` | 403 | The caller lacks permission for this action. |
| `not_found` | 404 | The resource is absent or inaccessible to this caller. |
| `conflict` | 409 | The request conflicts with the current resource state or an earlier request. |
| `over_capacity` | 409 | The request exceeds a resource or credential allowance. |
| `access_list_full` | 409 | The change would exceed the access-list allowance. |
| `payment_required` | 402 | Payment or credit is required. |
| `rate_limited` | 429 | The caller's request rate exceeds its limit. |
| `busy` | 429 | Too much work is in progress to accept this request. |
| `unknown` | 503 | The outcome is unconfirmed; a change may have happened. |
| `unavailable` | 503 | The service or requested feature is unavailable. |

## Notes

- CLI: `heaven login` with `HEAVEN_API_KEY` unset. MCP: Heaven sign-in. cURL: `HEAVEN_SIGN_IN_KEY` from approved device sign-in (`POST /v1/auth/create`).
- A key limited to a command list cannot run this command.

## Examples

```sh tab="heaven CLI"
heaven account name [NAME] [--clear]
```

```sh tab="SSH"
ssh cli@heaven.dev account name [NAME] [--clear]
```

```sh tab="cURL"
curl https://heaven.dev/v1/account/modify \
  -H "Authorization: Bearer $HEAVEN_SIGN_IN_KEY" \
  --json '{"action": "name", "name": "Ada Lovelace"}'
```

```json tab="MCP"
{ "tool": "account_name",
  "arguments": { "name": "Ada Lovelace" } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "name": "Ada Lovelace"
  }
}
```
