Create workspace group member

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

POST /api/v2/workspace-group-members

Create workspace group member

cURL

curl --request POST \
  --url https://api.instantly.ai/api/v2/workspace-group-members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sub_workspace_id": "019e3bd1-8e21-7752-9841-3de8b4c316d6"
}
'

200

{
  "id": "019e3bd1-8e21-7752-9841-3de6b34898bd",
  "admin_workspace_id": "019e3bd1-8e21-7752-9841-3de7ddd88879",
  "sub_workspace_id": "019e3bd1-8e21-7752-9841-3de8b4c316d6",
  "status": "accepted",
  "timestamp_created": "2026-05-18T16:00:49.697Z",
  "timestamp_updated": "2026-05-18T16:00:49.697Z",
  "sub_workspace_name": "My Workspace",
  "admin_workspace_name": "My Workspace"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The Workspace Group Member to create

The Workspace Group Member to create

sub_workspace_id · string<uuid> · required

The id of the sub workspace

Example:

"019e3bd1-8e21-7752-9841-3de8b4c316d6"

Response

200

application/json

The Workspace Group Member

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 · read-only

The unique identifier of the workspace group member

Example:

"019e3bd1-8e21-7752-9841-3de6b34898bd"

admin_workspace_id · string<uuid> · required · read-only

The id of the admin workspace

Example:

"019e3bd1-8e21-7752-9841-3de7ddd88879"

sub_workspace_id · string<uuid> · required

The id of the sub workspace

Example:

"019e3bd1-8e21-7752-9841-3de8b4c316d6"

status · enum<string> · required

Available options: pending, accepted, rejected

Example:

"accepted"

timestamp_created · string<date-time> · required · read-only

Example:

"2026-05-18T16:00:49.697Z"

timestamp_updated · string<date-time> · required · read-only

Example:

"2026-05-18T16:00:49.697Z"

sub_workspace_name · null | string · read-only

The name of the sub workspace.

Example:

"My Workspace"

admin_workspace_name · null | string · read-only

The name of the admin workspace.

Example:

"My Workspace"