API ReferenceInvitations

Create a new invitation

View as MarkdownOpen in Claude
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.

Authentication

Authorizationstring
The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings. Your API token does not have an expiry date and carries full permission, so be sure to keep them secure. If your token is leaked, delete it and create a new one directly in the app. In your requests add `Authorization` header with the value `Token <your token>`.

Request

This endpoint expects an object.
associationstringOptionalformat: "objectId"
The ID of the workspace to which the users are being invited.
emailslist of stringsOptional
An array of email addresses of the users to invite.
roleenumOptional
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.
Allowed values:

Response

Invitation created successfully
invitationslist of objects or null

Errors