PATCH
Update My Business

Body

application/json

Partial update for a business. Omitted fields are left unchanged.

name
string | null
rotate_api_key
boolean

Rotate the API key. The previous key stops working immediately and the new plaintext key is returned ONCE.

status
null | enum<string>

New status (ACTIVE / DISABLED). Admin-only in practice.

Available options:
PENDING,
ACTIVE,
DISABLED,
REJECTED

Response

Updated; rotated API key returned ONCE

Response to a business update. api_key is present only when rotated (ONCE).

id
string<uuid>
required
name
string
required
status
enum<string>
required

Whether a business may authenticate and transact.

Pending is the state a self-onboarded business is created in and stays in until an operator approves it. It exists so a half-finished application has somewhere to live: the alternative — creating the business only on approval — means an applicant who closes the tab has nothing to come back to.

Only Active authenticates. Pending and Rejected are both refused by [AuthenticatedBusiness], and the distinction between them is for the operator reading the list, not for the API.

Available options:
PENDING,
ACTIVE,
DISABLED,
REJECTED
updated_at
string<date-time>
required
api_key
string | null
api_key_prefix
string | null

Prefix of the newest live key, or None if the business has none.