Update organisation profile

PUT https://app.speybooks.com/api/v1/organisation/

Update the organisation's identity fields: name, VAT number, company number, contact details, address, and business type. Only include fields you want to change — omitted fields are left unchanged. Empty strings for nullable fields (VAT number, email, website) are converted to null.

Important: Address fields must be sent as flat top-level fields, not as a nested address object. The accepted fields are: addressLine1, addressLine2, city, region, postalCode, country (ISO 3166-1 alpha-2, e.g. "GB").

Request Fields

  • name — trading name (max 255 chars)
  • vatNumber — UK VAT number (max 20 chars)
  • companyNumber — Companies House number (max 20 chars)
  • email — contact email
  • phone — contact phone (max 30 chars)
  • website — URL
  • addressLine1 — first line of address (max 255 chars)
  • addressLine2 — second line of address (max 255 chars)
  • city — city (max 100 chars)
  • region — county/region (max 100 chars)
  • postalCode — postal code (max 20 chars)
  • country — ISO 3166-1 alpha-2 code (exactly 2 chars)
  • businessType — industry enum or null

Triggers an ORGANISATION_UPDATED audit log entry.

Body parameters

addressLine1 string optional nullable
Address line 1.
addressLine2 string optional nullable
Address line 2.
businessType string optional nullable
Business sector (it_contractor, construction, consulting, creative, retail, hospitality, healthcare, legal, property, transport, other).
city string optional nullable
City or town.
companyNumber string optional nullable
Companies House registration number (max 20 characters).
country string optional
ISO 3166-1 alpha-2 country code (e.g. GB).
email string optional nullable
Organisation contact email.
name string optional
Organisation display name (1-255 characters).
phone string optional nullable
Organisation contact phone (max 30 characters).
postalCode string optional nullable
Postcode (max 20 characters).
region string optional nullable
County or region.
vatNumber string optional nullable
VAT registration number (max 20 characters). Empty string clears the value.
website string optional nullable
Organisation website URL.

Response

200 Organisation profile updated. Returns the updated ID, name, slug, and timestamp.
Show response fields
id string
name string
slug string
updatedAt string date-time

Error codes

400 Validation error or no fields to update.