Invite user to project
Invitations
Invite user to project
Invite a user to join the project.
- For new users (not registered): Creates a pending invite and sends an email.
- For existing users: Automatically accepts the invite and sends a notification.
POST
Invite user to project
Authorizations
Use Authorization: Bearer
Path Parameters
UUID of the project
Body
application/json
Email address of the user to invite
Example:
Permissions to grant to the user
CAN_PERFORM_ADMIN_ACTIONS: Full administrative accessCAN_VIEW_DATA: Read-only access to project dataCAN_IMPERSONATE_OTHER_USERS: Impersonate other users in API calls (contact Clarifeye to enable)
Available options:
CAN_PERFORM_ADMIN_ACTIONS, CAN_VIEW_DATA, CAN_IMPERSONATE_OTHER_USERS Example:
Profile to assign to the invited user on the project.
Defaults to contributor when omitted.
Available options:
tech, contributor, user Response
Invitation created successfully
CAN_PERFORM_ADMIN_ACTIONS: Full administrative accessCAN_VIEW_DATA: Read-only access to project dataCAN_IMPERSONATE_OTHER_USERS: Impersonate other users in API calls (contact Clarifeye to enable)
Available options:
CAN_PERFORM_ADMIN_ACTIONS, CAN_VIEW_DATA, CAN_IMPERSONATE_OTHER_USERS Profile of the user on the project. The profile shapes the UI surface a
user sees (sidebar, available views) and complements the fine-grained
permissions list.
tech: Technical profile with access to advanced/technical interfacescontributor: Default profile for users who contribute to the projectuser: End-user profile with the most restricted UI surface
Available options:
tech, contributor, user pending: Invitation sent, awaiting responseaccepted: User accepted the invitationcancelled: Invitation was cancelled
Available options:
pending, accepted, cancelled new_user: User not registered, invite is pendingexisting_user: User exists, invite auto-accepted
Available options:
new_user, existing_user