Skip to main content
PATCH
Update a household or company account

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Path Parameters

id
integer
required

Body

application/json

Fields accepted when updating an account. Send only what changes; at least one field is required.

name
string
Maximum string length: 200
primaryContactId
integer

Must already be a member of the account

Maximum string length: 200
taxNumber
string | null

VAT or tax id

Maximum string length: 100
registrationNumber
string | null

Company registration number

Maximum string length: 100
billingEmail
string<email> | null
notes
string | null
Maximum string length: 2000

Response

The account as saved

A household or company account: the family or employer a group of contacts belongs to, which an invoice can be addressed to.

id
integer
type
enum<string>

organization is a legacy type: it is listed, but not created here.

Available options:
household,
company,
organization
name
string | null
primaryContactId
integer | null

The member the account is addressed to by default

Maximum string length: 200
taxNumber
string | null

VAT or tax id

Maximum string length: 100
registrationNumber
string | null

Company registration number

Maximum string length: 100
billingEmail
string<email> | null
notes
string | null
Maximum string length: 2000
memberCount
integer
createdAt
string<date-time>
members
object[]