Skip to main content
PATCH
Update an account

Authorizations

Authorization
string
header
required

Bearer authentication using your BookingShake API key. Retrieve your API key from Settings > Integrations in your BookingShake dashboard.

Path Parameters

id
string
required

Account ID (the id field carried by the account.* webhooks).

Body

application/json

Fields that can be updated on an account. All fields are optional (partial update): only the fields present in the body are modified. Same conventions as the response (English snake_case names). String fields are trimmed and limited to 255 characters; pass null on any field to clear it. Country fields are stored verbatim. Custom fields (custom_) configured for your venue can be set too; an unknown custom field key is rejected with 400. id and created_at are read-only and ignored. At least one field must be provided.

name
string | null

Company display name

Maximum string length: 255

Registered legal name

Maximum string length: 255
company_type
string | null

Legal form (e.g. SAS, SARL)

Maximum string length: 255
company_registration_id
string | null

Company registration number (SIREN in France)

Maximum string length: 255
siret
string | null

SIRET number (France)

Maximum string length: 255
vat_number
string | null

VAT number

Maximum string length: 255
rcs_number
string | null

Trade register number (RCS)

Maximum string length: 255
sector
string | null

Business sector

Maximum string length: 255
address_line_1
string | null

Main address

Maximum string length: 255
address_line_2
string | null

Main address, line 2

Maximum string length: 255
postal_code
string | null

Main address postal code

Maximum string length: 255
city
string | null

Main address city

Maximum string length: 255
country
string | null

Main address country, stored verbatim

Maximum string length: 255
billing_address_line_1
string | null

Billing address

Maximum string length: 255
billing_address_line_2
string | null

Billing address, line 2

Maximum string length: 255
billing_postal_code
string | null

Billing address postal code

Maximum string length: 255
billing_city
string | null

Billing address city

Maximum string length: 255
billing_country
string | null

Billing address country, stored verbatim

Maximum string length: 255
accounting_account
string | null

Accounting account code

Maximum string length: 255
{key}
any

Custom fields (custom_) configured for your venue: a string (single-value field) or an array of strings (multi-select field). An unknown custom field key, or a value whose shape does not match the field type, is rejected with 400.

Response

Account updated successfully. Returns the full account in its post-update state.

message
string
Example:

"success"

data
object

An account (company) attached to your venue. Every field is present with an explicit null when unset. Country fields are verbatim as entered. Custom fields (custom_<uuid>) configured for your venue are included, also with explicit null when unset.