v1

latestOpenAPI 3.0.02026-07-26392662.9 KB
Workspaces

Invite a user to a workspace

post/v1/workspaces/{uuid}/users/invite

Path parameters

uuidstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

UUID of the workspace

Request body

emailstring email

Example request

{
  "email": "john.doe@example.com"
}

Response

User invited

successboolean
messagestring

Example response

{
  "success": true,
  "message": "An invite link has been sent to john.doe@example.com",
  "data": {
    "invite_link": "https://app.snitcher.com/invite/12345"
  }
}