Create Organization

post

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

Use this API to create an organization within the organizational hierarchy.

🗒
Things to Know

The organization will be created as a child of the organization specified in the parentExternalId parameter. If a parentExternalIdvalue is not specified in the request, the organization will be created as a child of the root 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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

201Created

400Bad request

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