createOrganization()
Creates an Organization.
function createOrganization(params: CreateParams): Promise<Organization>- Name
- name
- Type
- string
- Description
- Name of the organization. 
 
- Name
- createdBy
- Type
- string
- Description
- The user ID for the user creating the organization. The user will become an administrator for the organization. 
 
- Name
- slug?
- Type
- string
- Description
- Slug of the organization. 
 
- Name
- publicMetadata?
- Type
- Description
- Metadata that can be read from both the Frontend API and Backend API, but can be set only from the Backend API. 
 
- Name
- privateMetadata?
- Type
- Description
- Metadata that is only visible to your Backend API. 
 
- Name
- maxAllowedMemberships?
- Type
- number
- Description
- The maximum number of memberships allowed in the organization. Setting this value to - 0removes any limit, allowing an unlimited number of memberships.
 
const name = 'test-org'
const createdBy = 'user_123'
const response = await clerkClient.organizations.createOrganization({ name, createdBy })Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint POST/organizations. See the BAPI reference for more information.
Feedback
Last updated on