Sign in
Project Invitations

Invite user to a project by email

Creates an invitation to a project for a user with the specified email address.

post/projects/{project_id}/invitations

Request body

role'admin' | 'viewer'

The role the invitee should be given on the project.

emailstring email required

The email address of the invitee.

forceboolean

Whether to cancel any pending invitation for the specified invitee, and create a new invitation.

Response

Created

idstring uuid

The ID of the invitation.

state'pending' | 'processing' | 'accepted' | 'cancelled' | 'error'

The invitation state.

project_idstring

The ID of the project.

role'admin' | 'viewer'

The project role.

emailstring email

The email address of the invitee.

created_atstring date-time

The date and time when the invitation was created.

updated_atstring date-time

The date and time when the invitation was last updated.

finished_atstring date-time nullable

The date and time when the invitation was finished.

Changes