PUT
Rename my organization
Organization space User accounts only For: Administrator · Permission: organizations.update Conditions
  • When name is sent it is required, must be a string of at most 120 characters, and is stored in lowercase; no uniqueness check is made on organization names.
Part of Run the organization and its companies.

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string | null

New name of the organization, at most 120 characters, stored in lowercase. Optional, but not null or empty when sent.

Maximum string length: 120

Response

OrganizationResource

id

Identifier of the organization (27-character KSUID string).

name

Name of the organization, stored in lowercase.

user_id

Identifier of the member who owns the organization (27-character KSUID string). Only this member can create companies and client accounts.

currency_code

3-character currency code of the organization's own books, set when the organization was created.

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.

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).