Add Users to Space

👥 Add Users to Space

Allows external clients to add one or more existing community members to a specific group (space) under that community.

This endpoint is intended for external vendor integrations that authenticate using an API key instead of browser session tokens.

HTTP Method

POST

Endpoint

/api/v1/admin/community/groups/users

Headers

Name	Type	Required	Description
x-api-key	String	✅ Yes	API key provided by the Networked Team. Used to authenticate external client requests.
spaceId	String	✅ Yes	UUID of the target group (space) to add users into. Identifies which group the users should be added to.
Content-Type	String	✅ Yes	Must be `application/json`.

Body Parameters

Name	Type	Required	Description
userId	String	✅ Yes	User ID(s) to add to the group. Pass a single UUID, or multiple UUIDs separated by commas (e.g. `uuid-1,uuid-2`). Whitespace around commas is trimmed.

Sample Request

{
  "userId": "dcb88996-2317-428d-b10d-07ecb5de95ee"
}

Batch Request Example

{
  "userId": "dcb88996-2317-428d-b10d-07ecb5de95ee,a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Sample Response (Success)

{
  "data": {},
  "error": false,
  "message": "Success"
}

Response Interface

interface AddUsersToSpaceResponse {
  data: Record<string, never>;
  error: boolean;
  message: string;
}

Response Field Descriptions

Field	Type	Description
data	Object	Empty object on success.
error	Boolean	`false` when the operation succeeds.
message	String	Descriptive message for the API outcome (e.g. `"Success"`).

Business Rules

The community identified by spaceId must be a ** space** with a parent community.

Each user in userId must already be an Accepted member of the parent community with a role assigned.

Users who are already Accepted members of the target space are rejected.

Users are added to the group with the same role they have on the parent community.

When multiple user IDs are provided, they are processed sequentially; the first failure stops the request (no partial success).

Common Error Responses

Code	Message (typical)	When
512	User ID is required	Missing or invalid `userId` in body.
512	User is already part of Community	User already has Accepted membership in this group.
525	No data found	Group has no parent community, or user is not an accepted parent member with a role.
555	The provided X-API-KEY is invalid or has expired.	Invalid or inactive `x-api-key`.
429	Too many requests	Rate limit exceeded (100 requests/minute per client).

Reference

🔗 Standard Response Codes

Notes

This API must be used with a valid x-api-key.

spaceId is required in the header and identifies the target Space; userId is required in the body and identifies the user(s) to add.

Rate limiting applies to all requests authenticated with x-api-key.

If x-api-key is omitted, the endpoint will fail.