API ReferenceReferenceUser groups
Create a user group
Creates an empty group. Add members with POST /user-groups/{groupId}/members and grant it access with POST /user-groups/{groupId}/grants -- group grants are additive-only (always allow).
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
Request 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
curl -X POST "https://example.com/user-groups" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "userGroup": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "createdAt": "2019-08-24T14:15:22Z", "memberCount": 0 }}