Update a client

Authorization

BearerAuth

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

All fields except name are optional. Money fields accept a number or a decimal-string. Empty strings are coerced to null.

name*string

contactName?string

email?string

phone?string

website?string

currency?string

ISO-4217 3-letter code; lowercased input is upper-cased server-side (e.g. usd → USD).

notes?string

billingAddress?string

Legacy free-form address. Prefer the structured billing* fields.

billingLine1?string

billingLine2?string

billingCity?string

billingRegion?string

billingPostalCode?string

billingCountry?string

taxNumber?string

defaultRate?string

Per-client default hourly rate (number or decimal-string, > 0). Inherited by new projects/invoices.

defaultPaymentTerms?string

defaultTaxRate?string

Default tax-rate percentage (number or decimal-string, 0–100, up to 4 dp).

billingEmail?string

requirePoNumber?boolean

When true, invoices for this client require a PO number.

Response Body

`application/json`

curl -X PATCH "https://example.com/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",    "name": "string",    "contactName": "string",    "email": "string",    "phone": "string",    "website": "string",    "currency": "string",    "notes": "string",    "billingAddress": "string",    "billingLine1": "string",    "billingLine2": "string",    "billingCity": "string",    "billingRegion": "string",    "billingPostalCode": "string",    "billingCountry": "string",    "taxNumber": "string",    "defaultRate": "string",    "defaultPaymentTerms": "string",    "defaultTaxRate": "string",    "requirePoNumber": true,    "billingEmail": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "deletedAt": "2019-08-24T14:15:22Z"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}

Was this page helpful?

Authorization

Path Parameters

Request Body

Response Body

200application/json

401application/json

402application/json

403application/json

404application/json

422application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`