Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Organizations API

Create an Organization

Use this endpoint to create an Organization. You can create multiple Organizations, but they must be added one at a time.

post/v1/organizations

Headers

Content-Typestring

The type of media of the resource. Recommended value is application/json.

X-Request-Idstring uuid

A unique identifier used to trace and track each request.

Authorizationstring

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Request body

legalNamestring required

The legal name of the Organization.

parentOrganizationIdstring uuid nullable

The unique identifier of the parent Organization.

doingBusinessAsstring nullable

The trade name of the Organization.

legalDocumentstring required

Official tax ID, company registration number, or other legal identification.

metadataMetadata

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Constraints: keys must be at most 100 characters; string values at most 2000 characters. Nested objects are not allowed (values must be string, number, or boolean), the structure may not exceed a maximum depth of 10, and a maximum of 100 keys is permitted.

Example request

{
  "legalDocument": "123456789012345"
}

Response

Indicates that the resource was successfully created and the operation was completed as expected.

idstring uuid

The unique identifier of the Organization.

legalNamestring

The legal name of the Organization.

parentOrganizationIdstring uuid nullable

The unique identifier of the parent Organization.

doingBusinessAsstring nullable

The trade name of the Organization.

legalDocumentstring

Official tax ID, company registration number, or other legal identification.

metadataMetadata

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Constraints: keys must be at most 100 characters; string values at most 2000 characters. Nested objects are not allowed (values must be string, number, or boolean), the structure may not exceed a maximum depth of 10, and a maximum of 100 keys is permitted.

createdAtstring date-time

Timestamp of creation (UTC).

updatedAtstring date-time

Timestamp of last update (UTC).

deletedAtstring date-time nullable

Timestamp of soft deletion, if applicable (UTC).

Example response

{
  "legalDocument": "123456789012345"
}