Skip to main content
PATCH
Rename organization

Authorizations

Authorization
string
header
required

API key sent in the Authorization header, with no Bearer prefix.

Path Parameters

organizationId
string<uuid>
required

The organization this call acts for: your API key's organization or one of its customer organizations. Any other id returns 404 not-found.

Body

application/json
displayName
string
required

The new name. Blank names and names over 200 characters return 400.

Maximum string length: 200

Response

The renamed organization.

id
string<uuid>
required
displayName
string
required
accountType
enum<string>
required

personal: an individual who completes KYC. business: a company that completes KYB.

Available options:
personal,
business
approvedAt
string<date-time> | null
required

When the organization's KYC or KYB was approved. Null until then.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required