Skip to main content
Use this endpoint to invite a user to a workspace. You need the invitee’s personal invite code, which they can retrieve from the Get Invite Code endpoint. You also assign them a group at invite time to control what they can do with workspace applications.

​
Request

POST https://api.virtuscloud.app/v2/workspaces/members

​
Headers

​
Authorization
string
required
Your Virtus Cloud API key. Pass it directly as the header value — no prefix required.Example: Authorization: vc_live_xxxxxxxxxxxx

​
Body

​
workspaceId
string
required
The unique identifier of the workspace to invite the member to.
​
code
string
required
The personal invite code of the user you want to add. Ask them to retrieve it from the Get Invite Code endpoint.
​
group
string
required
The permission group to assign to the new member, which controls their access to workspace applications. Contact your Virtus Cloud account documentation for available group names.

​
Response

​
status
string
Returns "success" when the member is added to the workspace successfully.

​
Examples

curl -X POST https://api.virtuscloud.app/v2/workspaces/members \
  -H "Authorization: <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "workspaceId": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
    "code": "9c1a499e623d2410226f1ecdc7e6daaec2fc6704",
    "group": "member"
  }'

​
Response Example

{
  "status": "success"
}