Grant a group access
Grants the group access to an app (a Flow or Agent) or a Suite -- every member inherits it immediately. Group grants are additive-only: there is no deny (use a per-user deny grant via POST /end-users instead).
Idempotent: a grant identical to one the group already holds (same target and Portal scope) is returned instead of duplicated (200 with created: false; a new grant returns 201). The target is validated before any write.
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/user-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/grants" \ -H "Content-Type: application/json" \ -d '{ "targetKind": "app", "targetId": "cbca1126-180e-4334-9df8-cf82289d378b" }'{ "ok": true, "grantId": "4eda52b3-a1b8-4aae-b545-9c8c3c9c7709", "created": true}