Update customer general settings

patch

https://api.doit.com/customers/v1/customers

Partially updates the general settings of the customer scoped to the authenticated tenant (from the bearer token). Requires the Settings permission and DoiT API access (platform:externalApi); updating allowedInviteDomains additionally requires the UsersManager permission.

The request body must use application/merge-patch+json (RFC 7396): an omitted field leaves the current value unchanged, and an explicit null also leaves it unchanged, except for urlSlug, where an explicit empty string removes the customer's active URL slug rather than leaving it unchanged.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Partial update to a customer's general settings. Every field is optional; only fields present in the request body are changed. See the operation description for urlSlug's null-vs-absent semantics, which differ from every other field.

currency

string

Billing currency code (e.g. USD, EUR).

emails

array of strings

Point-of-contact email addresses for the customer.

emails

urlSlug

string

The customer's URL display name. An explicit empty string removes the active slug; a non-empty value must be 3-12 characters of lowercase letters, digits, or dashes, starting and ending with a letter or digit, and must be unique across all customers.

allowedInviteDomains

array of strings

Email domains allowed to self-invite into the customer. Requires the UsersManager permission in addition to Settings.

allowedInviteDomains

Headers

X-Tenant-Id

string

Tenant (customer) identifier that conveys the tenant scope for the request
(DoiT API Design Standards §15).

Resolution when the header is absent:

A key scoped to exactly one tenant resolves to that tenant automatically; the header is
optional.
A principal that can access more than one tenant (e.g. DoiT-employee keys) must supply the
header. Without it the request is rejected with 400 and code tenant_id_required — the
server does not guess across tenant scopes.

When the header is present but conflicts with the tenant the key is scoped to, the request is
rejected with 400 and code tenant_id_mismatch.

Responses

200

OK - Customer general settings updated.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request - The server cannot process the request, often due to a malformed request.

401Unauthorized - Invalid API key.

403Forbidden - The client is not authorized to perform the request.

404Not Found - The requested resource does not exist.

409Conflict - The requested urlSlug is already assigned to another customer, or conflicts with an existing customer ID.

415Unsupported Media Type - The request Content-Type must be application/merge-patch+json.

422Unprocessable Entity - The customer has reached the limit of 5 previously-used URL slugs.

500Internal Server Error - Something went wrong with the DoiT API server.