---
title: "Update account name or settings"
method: PATCH
path: "/v1/accounts/{id}"
tags: ["Accounts"]
---

# Update account name or settings

`PATCH /v1/accounts/{id}`

## Request

- Base URL: `https://api.honkio.ca`
- URL: `https://api.honkio.ca/v1/accounts/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

name is required: an omitted or empty value is refused with 422 VALIDATION_ERROR.

Requires `account:m`.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string: Required.

## Response `200`

The updated account.

- Account: An account, as signup and PATCH /v1/accounts/{id} return it.
  - `id` string, required
  - `name` string, required
  - `email` string, required
  - `stripe_customer_id` string, nullable, required
  - `email_verified_at` string, date-time, nullable, required
  - `status` 'PENDING_PAYMENT' | 'ACTIVE' | 'SUSPENDED' | 'CLOSED', required
  - `balance_cents` integer, required: Credit balance in cents CAD.
  - `verified_phone` string, nullable, required
  - `phone_verified_at` string, date-time, nullable, required
  - `email_undeliverable` boolean, required: True when platform email to this address is bouncing or being marked as spam.
  - `email_undeliverable_at` string, date-time, nullable, required: The bounce or complaint that made the address unreachable.
  - `email_undeliverable_reason` string, nullable, required: BOUNCE or COMPLAINT.
  - `terms_accepted_at` string, date-time, nullable, required: When the owner accepted the Terms of Service and Privacy Policy.
  - `terms_version` string, nullable, required: The Terms version (last-updated date) that was accepted.
  - `created_at` string, date-time, required

## Other responses

- `401`: Missing, invalid, revoked or expired API key.
- `402`: The account has no balance, or a LIVE key was used before the first top-up.
- `403`: FORBIDDEN: the id is not the calling key's account, or the key lacks the permission this operation requires.
- `422`: VALIDATION_ERROR: the request failed validation; details names the fields.
- `429`: Rate limit reached: 100 requests per second per account, or a route-specific limit (Retry-After set where one applies).
- `500`: Unexpected server error.

---

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