---
title: "Create invite link"
method: POST
path: "/api/v1/invite-links"
tags: ["Organizations"]
---

# Create invite link

`POST /api/v1/invite-links`

Invite a new user to the organization and create an invite link for
them. If the email already belongs to a pending user, a new invite
link is generated for them. Only available to organization admins.

## Request body

- CreateInviteLink
  - `purpose` 'member' | 'setup'
  - `role` 'member' | 'viewer' | 'interactive_viewer' | 'editor' | 'developer' | 'admin'
  - `expiresAt` string, date-time
  - `email` string, required

## Response `201`

Created

- ApiInviteLinkResponse
  - `results` InviteLink, required
    - `purpose` 'member' | 'setup', required
    - `email` string, required
    - `userUuid` string, required
    - `organizationUuid` string, required
    - `inviteUrl` string, required
    - `inviteCode` string, required
    - `expiresAt` string, date-time, required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.net/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.net/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/versions/40c933755c9a/schema)