PRprolific
invitations

Create a new invitation

Changed on

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.

post/api/v1/invitations/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/invitations/
  • Auth
    API key in header Authorization

Request body

associationstring objectId

The ID of the workspace to which the users are being invited.

emailsstring[]

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

Invitation created successfully

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id create-invitation removed and replaced with invitations_CreateInvitation