Add an end user to a group
The end user immediately inherits the group's access grants. Idempotent: adding someone who is already a member succeeds with added: false. End-user ids come from POST or GET /end-users.
Alternatively pass email instead of endUserId: the address does not have to belong to an existing end user — a pending identity is pre-provisioned so the membership is already in place at their first sign-in. Either way the person is emailed an invite to sign in (best-effort, after the response) unless sendEmail is false.
A plan's group cannot be joined directly: people join it by holding the plan (code plan_group).
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
curl -X POST "https://example.com/user-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/members" \ -H "Content-Type: application/json" \ -d '{ "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5" }'{ "ok": true, "added": true, "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5"}