PUT
Update my client account
Client space User accounts only For: Administrator · Permission: clients.update Conditions
  • The name must be unique among the client accounts of the organization, compared in lowercase.
  • The logo must be an image of type jpeg, png, jpg, gif or svg, at most 2048 KB.
What else happens
  • Replaces the stored logo file when a new logo is sent, or removes it when logo is null; the previous file is deleted once the change is committed.
Part of Client accounts.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, organization_id, name, tax_registration_number, business_registration_number, address, city, country, logo_url, currency_code, currency_exponent, is_active, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Body

multipart/form-data
name
string

New name of the client account. Optional, but not null or empty when sent. At most 120 characters, stored in lowercase, and unique among the client accounts of the organization.

Maximum string length: 120
tax_registration_number
string | null

Tax registration number. Optional; null clears it. At most 250 characters.

Maximum string length: 250
business_registration_number
string | null

Business registration number. Optional; null clears it. At most 250 characters.

Maximum string length: 250
address
string | null

Street address. Optional; null clears it. At most 250 characters.

Maximum string length: 250
city
string | null

City. Optional; null clears it. At most 250 characters.

Maximum string length: 250
country
string | null

Country as free text. Optional; null clears it. At most 250 characters.

Maximum string length: 250
logo
file | null

Logo image file sent as multipart form data (jpeg, png, jpg, gif or svg, at most 2048 KB). Sending null removes the current logo; omitting the field keeps it.

Maximum string length: 2048

Response

Resource (only with response=resource).

id

Identifier of the client account (27-character KSUID string).

organization_id

Identifier of the organization the record belongs to.

name

Name of the client account, stored in lowercase.

tax_registration_number

Tax registration number of the client account; null when not set.

business_registration_number

Business registration number of the client account; null when not set.

address

Street address of the client account; null when not set.

city

City of the client account; null when not set.

country

Country of the client account as free text; null when not set.

logo_url

Public URL of the stored logo image, or null when no logo is set.

currency_code

3-character currency code of the client account, chosen when the client was created; it cannot be changed through this update.

currency_exponent
integer

Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.

is_active
boolean

Whether the client account is active. An organization turns it on or off with the activate and deactivate actions.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).