Update Organization

put

https://{hostname}/api/access/v1/external/organizations/{externalId}

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

Path Params

externalId

string

required

length between 1 and 100

The external identifier of the organization.

Body Params

externalId

string

required

length between 1 and 100

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

parentExternalId

string

length ≤ 100

The external identifier of the parent organization.

parentOrganizationId

uuid

The unique identifier of the parent organization.

defaultLanguageCode

string

length between 2 and 10

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

name

string

required

length between 1 and 100

The name of the organization.

defaultApprover

string

required

length between 5 and 77

The email address of the default approver for the organization.

description

string

length ≤ 250

A brief description of the organization.

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Forbidden

404

Organization not found

500

Internal Server Error

429Too Many Requests. For more information, see API Rate Limits.