Add a group member
⚠️
Preview — this feature is being built; the design below is the spec.
POST https://app.syntic.ai/v1/organizations/groups/{group_id}/membersAdd an existing organization member to a manual group.
For how this fits into a full workflow, see Groups and roles.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys. |
syntic-beta | Yes, while in preview | admin-2026-11-01. Without it the call fails with 400 beta_required. See Versioning. |
Content-Type | Yes | application/json |
Idempotency-Key | No | Up to 255 characters. Retrying with the same key within 24 hours returns the first result instead of acting twice. See Idempotency. |
Path parameters
| Parameter | Type | Description |
|---|---|---|
group_id | string | The group id, starting with grp_. |
Body parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
user_id | string | Yes | A member id, starting with user_. |
Response
201 Created, Content-Type: application/json
{
"user_id": "user_01J9Y0A2C4E6G8J0L2N4",
"email": "dana@example.com",
"added_at": "2026-10-01T09:00:00Z",
"added_by": "user_01J9X1B3D5F7H9K1M3P5"
}Examples
curl -sS "https://app.syntic.ai/v1/organizations/groups/grp_01JCM0N2Q4S6U8W0Y2A4/members" \
-H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
-H "syntic-beta: admin-2026-11-01" \
-H "Idempotency-Key: 8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69" \
-H "Content-Type: application/json" \
-d '{
"user_id": "user_01J9Y0A2C4E6G8J0L2N4"
}'Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request_error | beta_required | The syntic-beta header is missing. |
| 409 | conflict_error | already_member | The person is already in the group. |
| 403 | permission_error | scim_managed | Membership of SCIM groups comes from your identity provider. |
| 404 | not_found_error | group_not_found | No group with this id. |
| 401 | authentication_error | invalid_api_key | The admin key is missing, unknown, revoked or expired. |
| 403 | permission_error | admin_key_required | An inference key was used. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Was this page helpful?