Skip to main content
PATCH
Update organization

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Path Parameters

organizationId
string<uuid>
required

The unique identifier of the organization to update.

Body

Cancellation token.

Request body for updating an organization. All fields are optional; only provided fields are updated.

address
null | object

The organization's address. If provided, address1, city, country, and postalCode are required.

displayName
null | string

The display name of the organization.

The official legal name of the organization.

phoneNumber
null | string

The organization's phone number.

Response

Returns the updated organization details.

Response DTO for the organization details endpoint.

id
string<uuid>
required

The unique identifier of the organization.

displayName
string
required

The display name of the organization.

isEnabled
boolean
required

Whether the organization is currently enabled (active within the time window).

The legal name of the organization.

shortName
string
required

A short identifier for the organization.

types
enum<string>[]
required

The types assigned to the organization (e.g., VSP, Bank).

Available options:
BANK,
EMBEDDED,
PLATFORM,
TRANSACTOR,
VERTICAL_SOFTWARE_PROVIDER
address
null | object

The organization's address, if available.

childOrganizationTypeCounts
object

Counts of direct child organizations grouped by type (e.g., {"VERTICAL_SOFTWARE_PROVIDER": 3, "EMBEDDED": 2}). Empty dictionary if the organization has no children.

domainName
null | string

The domain name / website of the organization.

embeddedBusinessData
null | object

Embedded business entity data, populated when the target organization has embedded data.

logo
null | object

The organization's uploaded logo, including image metadata and CDN URLs. Null when no logo has been uploaded.

phoneNumber
null | string

The organization's phone number, if available.