group-types

Create group type

Creates a group type. An admin with no tenant_id creates a GLOBAL type; a tenant admin creates one in their own tenant. 409 group_type_reserved if a tenant type would take the slug of a RESERVED global type.

post/group-types

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/group-types
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Request body

descriptionstring
email_notificationsboolean

EmailNotifications opts groups of this type into membership email (groups.member_added / member_joined). Default false.

metadataobject
namestring
slugstring
tenant_idstring

TenantID targets a tenant-scoped type (admin only — a tenant_admin is always pinned to their own tenant). Empty = GLOBAL for an admin, the caller's own tenant for a tenant_admin (mirrors email templates).

Response

Created

successboolean

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.