| Field | Type | Required | Description | Example |
|---|---|---|---|---|
name |
str | ✔️ | The name of the new organization. May not contain URLs or HTML. |
NewOrg |
created_by |
Optional[str] | ➖ | The ID of the User who will become the administrator for the new organization | user_123 |
private_metadata |
Dict[str, Any] | ➖ | Metadata saved on the organization, accessible only from the Backend API | { "internal_code": "ABC123" } |
public_metadata |
Dict[str, Any] | ➖ | Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API | { "public_event": "Annual Summit" } |
slug |
Optional[str] | ➖ | A slug for the new organization. Can contain only lowercase alphanumeric characters and the dash "-". Must be unique for the instance. |
neworg |
max_allowed_memberships |
Optional[int] | ➖ | The maximum number of memberships allowed for this organization | 100 |
created_at |
Optional[str] | ➖ | A custom date/time denoting when the organization was created, specified in RFC3339 format (e.g. 2012-10-20T07:15:20.902Z). |