v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Organizations

Update Organization

Use this API to update the details of an existing organization within the organizational hierarchy.

put/api/access/v1/external/organizations/{externalId}

Path parameters

externalIdstring required

The external identifier of the organization.

Request body

externalIdstring required

The external identifier of the organization. Accepts alphanumeric characters, underscores, periods, colons, and hyphens.

parentExternalIdstring

The external identifier of the parent organization.

parentOrganizationIdstring uuid

The unique identifier of the parent organization.

defaultLanguageCodestring

The ISO language code for the organization's default language (for example: en, fr, de, es, zh).

namestring required

The name of the organization.

defaultApproverstring email required

The email address of the default approver for the organization.

descriptionstring

A brief description of the organization.

Example request

{
  "externalId": "ext-org-123",
  "parentExternalId": "ext-org-parent-456",
  "parentOrganizationId": "123e4567-e89b-12d3-a456-426614174002",
  "defaultLanguageCode": "en",
  "name": "OneTrust",
  "defaultApprover": "approver@onetrust.com",
  "description": "Privacy, Security and Third-Party Risk Software"
}

Response

No Content