Docs
API ReferenceReferenceUser groups

Remove a group grant

DELETE
/user-groups/{groupId}/grants/{grantId}

Members immediately lose the access that flowed through this grant; their accounts, plans, and per-user grants are untouched. Grant ids come from GET /user-groups/{groupId} or the POST that created them.

Requires the end_users:write scope.

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
grantId*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

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