Skip to main content

​
POST /api/v1/organizations

Creates a new organization in your environment. Use this endpoint to add a new tenant that can be configured with various settings and metadata.

​
Request

​
Body Parameters

​
display_name
string
required
Name of the organization. Must be between 1 and 200 characters.
Megasoft Inc
​
external_id
string
Your application’s unique identifier for this organization, used to link Scalekit with your system.
my_unique_id
​
metadata
object
Key-value pairs for storing additional organization information.
{
  "industry": "technology",
  "plan": "enterprise"
}

​
Response

​
organization
object
The newly created organization with its unique identifier and settings.

​
Examples

    Build docs developers (and LLMs) love

    Get started for freeTalk to us