Admit a group
Lets the group's members sign in at this portal. Members of an assigned group are admitted by membership; members of a self-service group by a live subscription on its plan. Idempotent: an already-admitted group succeeds with created: false and a 200. The group must belong to your organization; nothing is written otherwise. Requires the end_users:write scope.
Authorization
apiKey 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
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/portals/497f6eca-6276-4993-bfeb-53cbbbba6f08/admissions" \ -H "Content-Type: application/json" \ -d '{ "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55" }'{ "ok": true, "created": true, "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"}