Skip to content
Hoursmith Docs
APIReferenceOrganization

Update workspace settings

Update workspace settings. Owner or Admin only (Manager and Member tokens receive 403 forbidden_scope); write scope. TRUE PATCH: only supplied keys change — omitted fields keep their current values. Exposes exactly the Settings → General fields; never billing, email delivery, payment instructions, logo, members or credentials. Changing any of name, defaultCurrency, invoicePrefix, invoiceNextNumber, legalName, taxId, businessEmail, businessPhone, businessWebsite, businessAddress, businessAddressLine1, businessAddressLine2, businessCity, businessState, businessPostalCode, businessCountry, defaultInvoiceNotes, invoiceFooter alters what clients see on FUTURE invoices and invoice emails and requires confirm: true (422 with fields.confirm otherwise; nothing changes). Invoices already issued keep their frozen snapshots. Returns every settings field.

PATCH
/organization

Authorization

BearerAuth
AuthorizationBearer <token>

Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

True PATCH: only supplied keys change (omitted fields keep their current values; null clears an optional text). At least one setting is required. Unknown keys are rejected.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/organization" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "plan": "free",    "defaultCurrency": "string",    "invoicePrefix": "string",    "invoiceNextNumber": 0,    "defaultTaxRate": "string",    "defaultTimeRounding": "entry_15m",    "taxLabel": "string",    "defaultPaymentTerms": "string",    "defaultInvoiceNotes": "string",    "invoiceFooter": "string",    "legalName": "string",    "taxId": "string",    "businessAddress": "string",    "businessAddressLine1": "string",    "businessAddressLine2": "string",    "businessCity": "string",    "businessState": "string",    "businessPostalCode": "string",    "businessCountry": "string",    "businessEmail": "string",    "businessPhone": "string",    "businessWebsite": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
Was this page helpful?