Docs
API ReferenceReferencePortals

Stop admitting a group

DELETE
/portals/{portalId}/admissions/{groupId}

The group's members lose this door on their next sign-in or session refresh; anyone reaching the portal through another admitted group keeps it. Idempotent: a group that was not admitted succeeds with removed: false. 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

portalId*string
Formatuuid
groupId*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/portals/497f6eca-6276-4993-bfeb-53cbbbba6f08/admissions/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "ok": true,  "removed": true}