Skip to main content

Create a new organization

POST 
/api/v1/orgs

Add a new organization with the provided details.

Parameters

  • Request body: // - input (CreateOrgDto, required): the organization definition, including:
  • name (string, required, max length 100): the name of the organization.
  • parentOrgId (string, optional): the ID of the parent organization, if applicable.
  • description (string, optional, max length 200): description of the organization.
  • admins (list of userId, optional): list of admin users for this organization.

Responses

  • 201 Created: new organization created successfully.
  • 400 Bad Request: invalid input data.
  • 403 Forbidden: caller does not have permission to create orgs under the specified parent.
  • 404 Not Found: specified parent organization not found.
  • 409 Conflict: organization name already exists.

Security

  • This API requires authentication.

Request​

Responses​

Created