Delete a user group

Deletes the group; its memberships and group grants cascade away. The end-user accounts themselves -- their plans, credits, and per-user grants -- are untouched.

Requires the end_users:write scope.

Authorization

apiKey

AuthorizationBearer <token>

An organization API key, created from a Portal's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).

In: header

Path Parameters

groupId*string

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/user-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "ok": true}

Authorization

Path Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`