---
title: "Create workspace group member"
method: POST
path: "/api/v2/workspace-group-members"
tags: ["WorkspaceGroupMember"]
---

# Create workspace group member

`POST /api/v2/workspace-group-members`

This endpoint allows you to send an invitation for a sub workspace to join the admin workspace. The sub workspace will be added as a sub workspace of the admin workspace only if the sub workspace owner accepts the invitation.


Requires one of the following scopes: `workspace_group_members:create`, `workspace_group_members:all`, `all:create`, `all:all`

## Request body

- object — The Workspace Group Member to create
  - `sub_workspace_id` string, uuid, required — The id of the sub workspace

## Response `200`

The Workspace Group Member

- WorkspaceGroupMember — A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group.
  - `id` string, uuid, required — The unique identifier of the workspace group member
  - `admin_workspace_id` string, uuid, required — The id of the admin workspace
  - `sub_workspace_id` string, uuid, required — The id of the sub workspace
  - `status` 'pending' | 'accepted' | 'rejected', required
  - `timestamp_created` string, date-time, required
  - `timestamp_updated` string, date-time, required
  - `sub_workspace_name` string, nullable — The name of the sub workspace.
  - `admin_workspace_name` string, nullable — The name of the admin workspace.

## Other responses

- `400` — Invalid request body (e.g. missing required fields, or invalid field values)
- `401` — This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked)
- `402` — This request cannot be fulfilled because the workspace does not have an active paid plan
- `404` — The requested resource was not found
- `429` — You have exceeded the rate limit. Please check the rate limit docs for more information.

---

[API](https://skmtc.net/instantly/apis/api-explorer.md) · [All operations](https://skmtc.net/instantly/apis/api-explorer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/instantly/api-explorer/revisions/378d1e253fe7/schema)