Skip to main content
POST
/
v1
/
workspaces
/
{id}
/
members
Add Member to Workspace with Token
curl --request POST \
  --url https://api.vertracloud.app/v1/workspaces/{id}/members \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "role": "<string>"
}
'
{}
id
string
required
The ID of the workspace to add the member to.
code
string
required
The invite token code for adding the member.
role
string
The role to assign to the new member. Must be one of: owner, admin, developer, operator, viewer. Defaults to viewer.

Response

{}

Error Responses

code
string
The error code indicating the reason for failure. Possible values:
  • UNAUTHORIZED: The user is not authenticated or lacks sufficient permissions.
  • INSUFFICIENT_PERMISSIONS_TO_ADD_MEMBERS: The user does not have owner or admin role to add members.
  • ORGANIZATION_NOT_FOUND: The specified workspace does not exist.
  • INVALID_ROLE: The provided role is invalid.
  • ORGANIZATION_MEMBER_LIMIT_REACHED: The workspace has reached its member limit.
  • INVALID_OR_EXPIRED_TOKEN: The provided invite token is invalid or expired.
  • USER_ALREADY_IN_ORGANIZATION: The user is already a member of the workspace.
  • CODE_MUST_BE_STRING: The provided code is not a string.
message
string
A descriptive message providing additional details about the error.
{
  "code": "UNAUTHORIZED"
}