Create and send an invitation

Requires current Owner/Admin membership and an active workspace.

POST /api/v1/workspaces/{id}/invitations

Operation: createInvitation · Download OpenAPI

Access

Requires an authenticated Localisync panel session. The API checks current membership and permissions for workspace operations. See authentication and request rules.

sessionCookie

{
  "type": "apiKey",
  "in": "cookie",
  "name": "__Host-localisync-session"
}

Parameters

Name	Location	Required	Description
`id`	path	Yes	See constraints below.
`X-CSRF-Token`	header	Yes	See constraints below.
`Origin`	header	Yes	See constraints below.
`Idempotency-Key`	header	Yes	See constraints below.

id

{
  "type": "string",
  "format": "uuid"
}

X-CSRF-Token

{
  "type": "string"
}

Origin

{
  "type": "string",
  "format": "uri"
}

Idempotency-Key

{
  "type": "string",
  "format": "uuid"
}

Request body

Required: Yes.

application/json

Field	Type	Required	Constraints / description
`version`	integer	Yes	minimum: `1`
`email`	string	Yes	format: `"email"`; maxLength: `254`
`role`	`Admin`, `Editor`, `Viewer`	Yes	—

{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "minimum": 1
    },
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 254
    },
    "role": {
      "type": "string",
      "enum": [
        "Admin",
        "Editor",
        "Viewer"
      ]
    }
  },
  "required": [
    "version",
    "email",
    "role"
  ],
  "additionalProperties": false
}

Responses

201

Completed. For invitation creation/resend, inspect delivery; accepted means SMTP accepted the message.

Content type: application/json Schema reference: Invitation.

Field	Type	Required	Constraints / description
`id`	string	Yes	format: `"uuid"`
`workspaceId`	string	Yes	format: `"uuid"`
`workspaceName`	string	Yes	—
`email`	string	Yes	format: `"email"`
`role`	`Admin`, `Editor`, `Viewer`	Yes	—
`inviterId`	string	Yes	format: `"uuid"`
`recipientId`	string or null	Yes	format: `"uuid"`
`status`	`pending`, `accepted`, `declined`, `revoked`, `expired`	Yes	—
`delivery`	`preparing`, `accepted`, `unconfirmed`	Yes	—
`expiresAt`	string	Yes	format: `"date-time"`
`createdAt`	string	Yes	format: `"date-time"`

{
  "$ref": "#/components/schemas/Invitation"
}