group-types

Update group type

Patches a group type's name, description or metadata. 403 group_type_reserved on a RESERVED type (reserved_for set): those change by migration only.

patch/group-types/{id}

Request

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

Path parameters

idstring required

id

Request body

descriptionstring
email_notificationsboolean

EmailNotifications: tri-state like the rest of the patch — absent keeps the current value.

metadataobject
namestring

Response

OK

successboolean

Example response

{
  "success": true
}

Changes

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