SnozeDevelopers
API referenceWorkspaces

Invite someone to the workspace by email

Creates a pending invite at the requested role, queues the invitation email, and returns the invite together with its one-time token; re-inviting an address that already has a pending invite refreshes that invite and rotates its token instead of creating a second one. Requires `members:invite`, and only owners may invite owners. Fails when the email already belongs to a member, when the address or expiry is malformed, and when an editor-role invite would exceed the plan's seat allowance — viewer invites do not consume a seat.

POST
/v1/workspaces/{workspaceId}/invites

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string

Request Body

application/json
  1. body
email*string
role*string
Value in"owner""admin""builder""member""operator""viewer"
expiresAt?string|null

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.snoze.dev/v1/workspaces/string/invites' \  -H 'Content-Type: application/json' \  -d '{  "email": "string",  "role": "owner"}'
Example Response
{  "data": {    "id": "string",    "workspaceId": "string",    "email": "string",    "role": "owner",    "status": "pending",    "token": "string",    "expiresAt": "string",    "createdAt": "string",    "updatedAt": "string"  }}