Update a customer's settings

Updates the settings of a customer by its accounting system ID (id on the customer object). Accepts only the settings defined in the request schema, using the same field names and nesting that GET returns. Every field is optional and only the fields sent are changed; nested objects are merged, not replaced. An empty body, an empty nested object, or an unknown field is rejected.

Some settings are not available to every organization (for example Invoice Rover depends on the plan). Sending any value for a setting that is unavailable to the organisation returns 400 and the detail names the setting and the reason. Returns the updated customer in the same shape as GET.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 200

The accounting system customer ID (e.g. the QuickBooks Id, Xero ContactID, Business Central id, or QBD ListID). This is the value exposed as id on the customer object.

Body Params

Customer settings to change. Only fields defined in this request schema are accepted, using the same names and nesting as the customer object returned by GET. Every field is optional and only the fields sent are changed; nested objects are merged, not replaced.

boolean

Invoice Rover for this customer. true disables Invoice Rover notifications, false enables them. Rejected (any value) when Invoice Rover is not available on the organization's plan.

autoPaySettings
object

Per-customer auto-pay / processing settings to change. Only the fields sent are changed.

portalSettings
object

Per-customer portal settings to change. Only the fields sent are changed.

Headers
uuid

Optional client-supplied unique ID for one request. The server generates a UUID v4 if omitted and always echoes the value in the response.

uuid

Optional ID that flows across service boundaries for distributed tracing. The server generates a UUID v4 if omitted and always echoes the value in the response.

string
length between 1 and 255
^[a-zA-Z0-9]+$

Optional client-supplied key that makes retries safe for POST/PATCH/PUT. Scoped per actor; cached for 24 hours. Replays return the cached response with X-Idempotency-Replayed: true. Same key with a different body returns 409. In-flight duplicates return 429 with Retry-After. See the Idempotency section in the API overview.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json