Field | Type | Required | Description |
---|---|---|---|
name |
string | ✔️ | The name of the new organization. May not contain URLs or HTML. |
createdBy |
string | ✔️ | The ID of the User who will become the administrator for the new organization |
privateMetadata |
array<string, mixed> | ➖ | Metadata saved on the organization, accessible only from the Backend API |
publicMetadata |
array<string, mixed> | ➖ | Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API |
slug |
?string | ➖ | A slug for the new organization. Can contain only lowercase alphanumeric characters and the dash "-". Must be unique for the instance. |
maxAllowedMemberships |
?int | ➖ | The maximum number of memberships allowed for this organization |
createdAt |
?string | ➖ | A custom date/time denoting when the organization was created, specified in RFC3339 format (e.g. 2012-10-20T07:15:20.902Z ). |