Skip to main content
POST
Create an Organization

Headers

Content-Type
string

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

X-Request-Id
string<uuid>

A unique identifier used to trace and track each request.

Authorization
string

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>

Body

application/json

The legal name of the Organization.

Maximum string length: 256

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

Maximum string length: 256
Example:

"123456789012345"

parentOrganizationId
string<uuid> | null

The unique identifier of the parent Organization.

doingBusinessAs
string | null

The trade name of the Organization.

Maximum string length: 256
status
object

An object containing information about the status. Important: If not provided, the default status will be 'ACTIVE'.

address
object

An object containing information about the address of the Organization.

metadata
object

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.

Response

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

id
string<uuid>

The unique identifier of the Organization.

The legal name of the Organization.

Maximum string length: 256
parentOrganizationId
string<uuid> | null

The unique identifier of the parent Organization.

doingBusinessAs
string | null

The trade name of the Organization.

Maximum string length: 256

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

Maximum string length: 256
Example:

"123456789012345"

status
object

An object containing information about the status.

address
object

An object containing information about the address of the Organization.

metadata
object

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.

createdAt
string<date-time>

Timestamp of creation (UTC).

updatedAt
string<date-time>

Timestamp of last update (UTC).

deletedAt
string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).