SIsimplelocalize
Projects

Invite project contributor

Changed on

Invite a new contributor to the project. The contributor will receive an email with an invitation link same as in the web app.

  • The contributor will be able to accept the invitation and join the project.
  • The endpoint requires Personal Token for authentication and the project must be on a paid plan to manage contributors.
  • The endpoint is rate-limited to 1 request per second.
  • The request body must contain the contributor's email, role, and optional assigned languages, tags, and customers.
  • The role can be either TRANSLATOR or ADMIN. Only TRANSLATOR role allows to define assigned languages, tags, and customers.
  • The assigned languages, tags, and customers must be defined in the request body.
  • The default access level for languages, tags, and customers can be defined in the request body.

Translator role permissions

  • VIEW_ACTIVITY
  • IMPORT_FILES
  • EXPORT_FILES
  • MANAGE_TRANSLATION_KEYS
  • MANAGE_LANGUAGES
  • AUTO_TRANSLATE
  • CHANGE_TRANSLATIONS
  • REVIEW_TRANSLATIONS
  • CHANGE_CUSTOMER_TRANSLATIONS
  • REVIEW_CUSTOMER_TRANSLATIONS
  • CHANGE_DESCRIPTION
  • PUBLISH_TRANSLATIONS
  • ACCESS_COMMENTS

Access levels: ALLOW and DENY.

Language access levels:

  • WRITE_READ means the contributor can perform the action.
  • READ means the contributor can read the translations, but cannot write them.
  • HIDDEN means the contributor cannot perform the action.

Tag and Customer access levels:

  • WRITE_READ means the contributor can perform the action.
  • HIDDEN means the contributor cannot perform the action.
post/api/v1/projects/{projectToken}/contributors

Request

Path parameters

projectTokenstring required

Request body

emailstring email required

Email of the contributor. Must be a valid email address.

role'TRANSLATOR' | 'ADMIN' | 'DEVELOPER' required

Role of the contributor. Only 'TRANSLATOR' role allows to define assigned languages, tags, and customers. 'DEVELOPER' has the same access as 'ADMIN', except for the project Settings tab and managing project members.

defaultLanguageAccess'ALLOW' | 'DENY'

Default access level for languages. Only applicable if role is 'TRANSLATOR'.

defaultTagAccess'ALLOW' | 'DENY'

Default access level for tags. Only applicable if role is 'TRANSLATOR'.

defaultCustomerAccess'ALLOW' | 'DENY'

Default access level for customers. Only applicable if role is 'TRANSLATOR'.

Example request

{
  "email": "john@exmaple.com",
  "role": "TRANSLATOR",
  "assignedLanguages": [
    {
      "key": "en",
      "access": "ALLOW"
    }
  ],
  "defaultLanguageAccess": "ALLOW",
  "assignedTags": [
    {
      "name": "marketing",
      "access": "ALLOW"
    }
  ],
  "defaultTagAccess": "ALLOW",
  "assignedCustomers": [
    {
      "key": "customer123",
      "access": "ALLOW"
    }
  ],
  "defaultCustomerAccess": "ALLOW",
  "permissions": [
    {
      "key": "AUTO_TRANSLATE",
      "access": "ALLOW"
    }
  ]
}

Response

OK

Changes

  • 67a25a25863aRevision changes
    • breaking

      removed the enum value AUTO_TRANSLATE CHANGE_TRANSLATIONS REVIEW_TRANSLATIONS PUBLISH_TRANSLATIONS MANAGE_TRANSLATION_KEYS ADD_LANGUAGES UPDATE_LANGUAGES DELETE_LANGUAGES IMPORT_FILES EXPORT_FILES VIEW_ACTIVITY ACCESS_COMMENTS CHANGE_CUSTOMER_TRANSLATIONS REVIEW_CUSTOMER_TRANSLATIONS CHANGE_DESCRIPTION of the request property //

    • info

      added the new AUTO_TRANSLATE CHANGE_TRANSLATIONS REVIEW_TRANSLATIONS PUBLISH_TRANSLATIONS MANAGE_TRANSLATION_KEYS MANAGE_LANGUAGES IMPORT_FILES EXPORT_FILES VIEW_ACTIVITY ACCESS_COMMENTS CHANGE_CUSTOMER_TRANSLATIONS REVIEW_CUSTOMER_TRANSLATIONS CHANGE_DESCRIPTION enum value to the request property //

    • info

      added the new DEVELOPER enum value to the request property

  • 0329534cd557Revision changes
    • info

      endpoint added