Tolgee Octri Demo
PUT/v2/projects/{projectId}/invite

Create a project invitation

Creates an invitation for a user to join a project and returns the invitation details. Supply the invitee's email and any applicable permissions, including the permission type or language-specific scopes. Use the language-specific fields to limit the languages the invitee can view, translate, review, or manage suggestions for.

1 parameter · 11 body fields
projectIdintegerrequired
The numeric identifier of the project to invite the user to.

Invitation details and optional project permissions for the invitee.

agencyIdintegeroptional
Id of invited agency
emailstringoptional
Email to send invitation to
languagesarray<integer>deprecatedoptional
Deprecated -> use translate languages
namestringoptional
Name of invited user
scopesarray<string>optional
Granted scopes for the invited user
stateChangeLanguagesarray<integer>optional
Languages user can change translation state (review)
suggestLanguagesarray<integer>optional
Languages user can suggest translation
suggestManageLanguagesarray<integer>optional
Languages user can manage suggestions for
translateLanguagesarray<integer>optional
Languages user can translate to
typestringoptional
The invitee's permission type: NONE, VIEW, TRANSLATE, REVIEW, EDIT, or MANAGE.
Allowed:NONEVIEWTRANSLATEREVIEWEDITMANAGE
viewLanguagesarray<integer>optional
Languages user can view

5 status codes
200Returns the created invitation, including its identifier, creation time, invitee details, and permission settings.
codestringoptional
createdAtstringrequired
createdByobjectoptional
idintegerrequired
invitedUserEmailstringoptional
invitedUserNamestringoptional
permissionobjectrequired
permittedLanguageIdsarray<integer>deprecatedoptional
Use permission object instead
typestringdeprecatedoptional
Use permission object instead
Allowed:NONEVIEWTRANSLATEREVIEWEDITMANAGE
400Returned when the request is invalid, such as when a supplied value fails validation.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when access to the requested resource is forbidden.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the requested project is not found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned for a malformed request, a 401 when the request is unauthenticated, a 403 when access is forbidden, and a 404 when the project is not found. The projectId path parameter must identify the project for the invitation. If provided, email must be a valid email address of no more than 250 characters, name must not exceed 250 characters, and type must be one of NONE, VIEW, TRANSLATE, REVIEW, EDIT, or MANAGE.