Skip to main content
POST
/
accounts
/
{account_id}
/
invitations
cURL
curl "https://api.phrase.com/v2/accounts/:account_id/invitations" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -d '{"email":"[email protected]","role":"Developer","project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235","locale_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235","space_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],"team_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],"default_locale_codes":["de","en"],"permissions":{"create_upload":true,"review_translations":true}}' \
  -H 'Content-Type: application/json'
{
  "id": "acbdacbdacbdacbdacbdacbd",
  "email": "[email protected]",
  "role": "Manager",
  "state": "accepted",
  "projects": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "My Android Project",
      "main_format": "xml",
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z"
    }
  ],
  "locales": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "English",
      "code": "en-GB"
    }
  ],
  "default_locale_codes": [
    "en",
    "de"
  ],
  "permissions": [
    {
      "create_upload": true,
      "review_translations": true
    }
  ],
  "locale_ids": [
    "abcd1234abcd1234abcd1234",
    "abcd1234abcd1234abcd1235"
  ],
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "accepted_at": "2015-02-28T09:52:53Z",
  "spaces": [
    {
      "id": "04d36d845576b9d494d05e0b70fe813b",
      "name": "Space2",
      "created_at": "2020-12-07T12:56:21Z",
      "updated_at": "2020-12-07T12:56:21Z",
      "projects_count": 1
    }
  ],
  "teams": [
    {
      "id": "04d36d845576b9d494d05e0b70fe813c",
      "name": "Team 1",
      "created_at": "2020-12-07T12:56:21Z",
      "updated_at": "2020-12-07T12:56:21Z"
    }
  ],
  "project_roles": [
    {
      "project_id": "abcd1234cdef1234abcd1234cdef1234",
      "role": "Developer"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

​
X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

​
account_id
string
required

Account ID

Body

application/json
​
email
string
required

The email of the invited user. The email can not be updated once created. Create a new invitation for each unique email.

Example:

"[email protected]"

​
role
string
required

Invitiation role, can be any of Manager, Developer, Translator.

Example:

"Developer"

​
project_ids
string

List of project ids the invited user has access to.

Example:

"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235"

​
locale_ids
string

List of locale ids the invited user has access to.

Example:

"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235"

​
space_ids
string[]

List of spaces the user is assigned to.

Example:
[
  "abcd1234abcd1234abcd1234",
  "abcd1234abcd1234abcd1235"
]
​
team_ids
string[]

List of teams the user is assigned to.

Example:
[
  "abcd1234abcd1234abcd1234",
  "abcd1234abcd1234abcd1235"
]
​
default_locale_codes
string[]

List of default locales for the user.

Example:
["en", "de"]
​
permissions
object

Additional permissions depending on invitation role. Available permissions are create_upload and review_translations

Example:
{
  "create_upload": true,
  "review_translations": true
}

Response

Created

​
id
string
​
email
string
​
role
string
​
state
string
​
projects
project_short · object[]
​
locales
locale_preview · object[]
​
teams
team_short · object[]
​
default_locale_codes
string[]
​
permissions
object
​
locale_ids
string[]
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
accepted_at
string<date-time>
​
spaces
any[]
​
project_role
object[]