Skip to main content

Generate user invitation link for project

PUT 

/v2/projects/:projectId/invite

Generate user invitation link for project

Request

Path Parameters

    projectId int64required

Body

required
    agencyId int64

    Id of invited agency

    email string

    Possible values: <= 250 characters

    Email to send invitation to

    languages int64[]deprecated

    Deprecated -> use translate languages

    name string

    Possible values: <= 250 characters

    Name of invited user

    scopes string[]

    Granted scopes for the invited user

    stateChangeLanguages int64[]deprecated

    Languages user can change translation state (review)

    translateLanguages int64[]deprecated

    Languages user can translate to

    type string

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    viewLanguages int64[]deprecated

    Languages user can view

Responses

OK

Schema
    code string
    createdAt date-timerequired
    createdBy object
    avatar object
    large stringrequired
    thumbnail stringrequired
    deleted booleanrequired
    id int64required
    name string
    username stringrequired
    id int64required
    invitedUserEmail string
    invitedUserName string
    permission objectrequired
    agency object
    avatar object
    large stringrequired
    thumbnail stringrequired
    id int64required
    name stringrequired
    url string
    permittedLanguageIds int64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.

    scopes string[]required

    Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage, tasks.view, tasks.edit]

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    stateChangeLanguageIds int64[]

    List of languages user can change state to. If null, changing state of all language values is permitted.

    translateLanguageIds int64[]

    List of languages user can translate to. If null, all languages editing is permitted.

    type string

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    The user's permission type. This field is null if uses granular permissions

    viewLanguageIds int64[]

    List of languages user can view. If null, all languages view is permitted.

    permittedLanguageIds int64[]
    type string

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

Loading...