Invite a user to a workspace

POST

https://api.plusvibe.ai/api/v1/workspaces/invite

Invites a user, by email address, to join a workspace with the given role.

⚠️ Two possible outcomes — check auto_added in the response:
Auto-added instantly: if the invited user already has an account and is already a member of at least one workspace in the same organization as the target workspace, they are added to the workspace immediately — no invitation email is sent and no acceptance is needed. The response returns auto_added: true and _id: null.
Manual acceptance required: in every other case an invitation email is sent, and the invited user must accept it themselves (signed in with the invited email address) before they join the workspace. Each invitation must be accepted individually. The response returns auto_added: false and _id set to the invitation ID.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

User invited or auto-added successfully. auto_added tells you which happened.

Bodyapplication/json

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.plusvibe.ai/api/v1/workspaces/invite' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workspace_id": "66c5860c0d3839cddfe96a31",
    "email": "jane@example.com",
    "role_name": "WORKSPACE_ADMIN"
}'

Response Example

200 - Invitation sent — user must accept manually

{
    "_id": "675fb8aca8d7a0a931119c58",
    "auto_added": false,
    "workspace_id": "66c5860c0d3839cddfe96a31",
    "role_name": "WORKSPACE_MEMBER"
}

Modified at 2026-07-26 17:00:38

Copy workspace settings

Create a new campaign