---
title: "Create a new invitation"
method: POST
path: "/api/v1/invitations/"
tags: ["invitations"]
---

# Create a new invitation

`POST /api/v1/invitations/`

Initiate a new invitation process for adding users to a Workspace.

This operation can be performed only by authenticated users who are admins for the specified workspace. Invitations will be sent to the email addresses provided in the request.

## Headers

- `Authorization` string, required

## Request body

- CreateInvitationRequest
  - `association` string, objectId — The ID of the workspace to which the users are being invited.
  - `emails` string[] — An array of email addresses of the users to invite.
  - `role` 'WORKSPACE_ADMIN' | 'WORKSPACE_COLLABORATOR' — The role that the invited users will have in the workspace. This can be one of the following: - "WORKSPACE_ADMIN": The user will have administrative rights in the workspace. They can manage settings, invite users, and oversee all projects. - "WORKSPACE_COLLABORATOR": The user will be a regular collaborator in the workspace. They can contribute to projects but don't have administrative rights.

## Response `201`

Invitation created successfully

- CreateInvitationResponse
  - `invitations` Invitation[]
    - `association` string, objectId — The ID of the workspace to which the invitee was invited.
    - `invitee` InvitationInvitee
      - `id` string, objectId, nullable — The unique ID of the invitee.
      - `name` string, nullable — The name of the invitee.
      - `email` string, email — The email address of the invitee.
    - `invited_by` string, objectId — The ID of the user who sent the invitation.
    - `status` 'INVITED' | 'ACCEPTED' — The current status of the invitation.
    - `invite_link` string, uri — The link that the invitee can use to accept the invitation.
    - `role` 'WORKSPACE_ADMIN' | 'WORKSPACE_COLLABORATOR' — Assigned role for the user in this workspace.

## Other responses

- `400` — Error

---

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