Invite User To Workspace
POST/api/v1/workspaces/:workspace_name/invitation
Invites a user directly to a specific workspace with the specified role.
This endpoint allows workspace administrators to invite users directly to their workspace, bypassing the organization-level invitation process. The user will be:
- Created in the deepset Platform if they don't already exist
- Added to the organization if they're not already a member
- Assigned the specified role within the target workspace
Required Permissions: WORKSPACE_MEMBERS write permission on the target workspace.
Valid preset roles are: ADMIN, EDITOR
Request
Responses
- 201
- 402
- 409
- 422
- 503
User invited to workspace.
Inviting users is not available on the free plan. To invite team members, please upgrade to a paid plan.
The user already belongs to the organization.
Validation Error
Something went wrong during signup.
Was this page helpful?