Create a new invitation

cURL

curl "https://api.phrase.com/v2/accounts/:account_id/invitations" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -d '{"email":"example@mail.com","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'

phrase invitations create \
--account_id <account_id> \
--data '{"email":"example@mail.com", "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}"}' \
--access_token <token>

import requests

url = "https://api.phrase.com/v2/accounts/{account_id}/invitations"

payload = {
    "email": "example@mail.com",
    "role": "Developer",
    "project_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235",
    "locale_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235",
    "space_ids": ["abcd1234abcd1234abcd1234", "abcd1234abcd1234abcd1235"],
    "team_ids": ["abcd1234abcd1234abcd1234", "abcd1234abcd1234abcd1235"],
    "default_locale_codes": ["en", "de"],
    "permissions": {
        "create_upload": True,
        "review_translations": True
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'example@mail.com',
    role: 'Developer',
    project_ids: 'abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235',
    locale_ids: 'abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235',
    space_ids: ['abcd1234abcd1234abcd1234', 'abcd1234abcd1234abcd1235'],
    team_ids: ['abcd1234abcd1234abcd1234', 'abcd1234abcd1234abcd1235'],
    default_locale_codes: ['en', 'de'],
    permissions: {create_upload: true, review_translations: true}
  })
};

fetch('https://api.phrase.com/v2/accounts/{account_id}/invitations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.phrase.com/v2/accounts/{account_id}/invitations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'example@mail.com',
    'role' => 'Developer',
    'project_ids' => 'abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235',
    'locale_ids' => 'abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235',
    'space_ids' => [
        'abcd1234abcd1234abcd1234',
        'abcd1234abcd1234abcd1235'
    ],
    'team_ids' => [
        'abcd1234abcd1234abcd1234',
        'abcd1234abcd1234abcd1235'
    ],
    'default_locale_codes' => [
        'en',
        'de'
    ],
    'permissions' => [
        'create_upload' => true,
        'review_translations' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.phrase.com/v2/accounts/{account_id}/invitations"

	payload := strings.NewReader("{\n  \"email\": \"example@mail.com\",\n  \"role\": \"Developer\",\n  \"project_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\",\n  \"locale_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\",\n  \"space_ids\": [\n    \"abcd1234abcd1234abcd1234\",\n    \"abcd1234abcd1234abcd1235\"\n  ],\n  \"team_ids\": [\n    \"abcd1234abcd1234abcd1234\",\n    \"abcd1234abcd1234abcd1235\"\n  ],\n  \"default_locale_codes\": [\n    \"en\",\n    \"de\"\n  ],\n  \"permissions\": {\n    \"create_upload\": true,\n    \"review_translations\": true\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.phrase.com/v2/accounts/{account_id}/invitations")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"example@mail.com\",\n  \"role\": \"Developer\",\n  \"project_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\",\n  \"locale_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\",\n  \"space_ids\": [\n    \"abcd1234abcd1234abcd1234\",\n    \"abcd1234abcd1234abcd1235\"\n  ],\n  \"team_ids\": [\n    \"abcd1234abcd1234abcd1234\",\n    \"abcd1234abcd1234abcd1235\"\n  ],\n  \"default_locale_codes\": [\n    \"en\",\n    \"de\"\n  ],\n  \"permissions\": {\n    \"create_upload\": true,\n    \"review_translations\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.phrase.com/v2/accounts/{account_id}/invitations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"example@mail.com\",\n  \"role\": \"Developer\",\n  \"project_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\",\n  \"locale_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\",\n  \"space_ids\": [\n    \"abcd1234abcd1234abcd1234\",\n    \"abcd1234abcd1234abcd1235\"\n  ],\n  \"team_ids\": [\n    \"abcd1234abcd1234abcd1234\",\n    \"abcd1234abcd1234abcd1235\"\n  ],\n  \"default_locale_codes\": [\n    \"en\",\n    \"de\"\n  ],\n  \"permissions\": {\n    \"create_upload\": true,\n    \"review_translations\": true\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "acbdacbdacbdacbdacbdacbd",
  "email": "foo@bar.com",
  "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"
    }
  ]
}

{
  "message": "Validation Failed",
  "errors": [
    {
      "resource": "Resource",
      "field": "name",
      "message": "can't be blank"
    }
  ]
}

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":"example@mail.com","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'

phrase invitations create \
--account_id <account_id> \
--data '{"email":"example@mail.com", "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}"}' \
--access_token <token>

import requests

url = "https://api.phrase.com/v2/accounts/{account_id}/invitations"

payload = {
    "email": "example@mail.com",
    "role": "Developer",
    "project_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235",
    "locale_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235",
    "space_ids": ["abcd1234abcd1234abcd1234", "abcd1234abcd1234abcd1235"],
    "team_ids": ["abcd1234abcd1234abcd1234", "abcd1234abcd1234abcd1235"],
    "default_locale_codes": ["en", "de"],
    "permissions": {
        "create_upload": True,
        "review_translations": True
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'example@mail.com',
    role: 'Developer',
    project_ids: 'abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235',
    locale_ids: 'abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235',
    space_ids: ['abcd1234abcd1234abcd1234', 'abcd1234abcd1234abcd1235'],
    team_ids: ['abcd1234abcd1234abcd1234', 'abcd1234abcd1234abcd1235'],
    default_locale_codes: ['en', 'de'],
    permissions: {create_upload: true, review_translations: true}
  })
};

fetch('https://api.phrase.com/v2/accounts/{account_id}/invitations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.phrase.com/v2/accounts/{account_id}/invitations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'example@mail.com',
    'role' => 'Developer',
    'project_ids' => 'abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235',
    'locale_ids' => 'abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235',
    'space_ids' => [
        'abcd1234abcd1234abcd1234',
        'abcd1234abcd1234abcd1235'
    ],
    'team_ids' => [
        'abcd1234abcd1234abcd1234',
        'abcd1234abcd1234abcd1235'
    ],
    'default_locale_codes' => [
        'en',
        'de'
    ],
    'permissions' => [
        'create_upload' => true,
        'review_translations' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.phrase.com/v2/accounts/{account_id}/invitations"

	payload := strings.NewReader("{\n  \"email\": \"example@mail.com\",\n  \"role\": \"Developer\",\n  \"project_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\",\n  \"locale_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\",\n  \"space_ids\": [\n    \"abcd1234abcd1234abcd1234\",\n    \"abcd1234abcd1234abcd1235\"\n  ],\n  \"team_ids\": [\n    \"abcd1234abcd1234abcd1234\",\n    \"abcd1234abcd1234abcd1235\"\n  ],\n  \"default_locale_codes\": [\n    \"en\",\n    \"de\"\n  ],\n  \"permissions\": {\n    \"create_upload\": true,\n    \"review_translations\": true\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.phrase.com/v2/accounts/{account_id}/invitations")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"example@mail.com\",\n  \"role\": \"Developer\",\n  \"project_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\",\n  \"locale_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\",\n  \"space_ids\": [\n    \"abcd1234abcd1234abcd1234\",\n    \"abcd1234abcd1234abcd1235\"\n  ],\n  \"team_ids\": [\n    \"abcd1234abcd1234abcd1234\",\n    \"abcd1234abcd1234abcd1235\"\n  ],\n  \"default_locale_codes\": [\n    \"en\",\n    \"de\"\n  ],\n  \"permissions\": {\n    \"create_upload\": true,\n    \"review_translations\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.phrase.com/v2/accounts/{account_id}/invitations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"example@mail.com\",\n  \"role\": \"Developer\",\n  \"project_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\",\n  \"locale_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\",\n  \"space_ids\": [\n    \"abcd1234abcd1234abcd1234\",\n    \"abcd1234abcd1234abcd1235\"\n  ],\n  \"team_ids\": [\n    \"abcd1234abcd1234abcd1234\",\n    \"abcd1234abcd1234abcd1235\"\n  ],\n  \"default_locale_codes\": [\n    \"en\",\n    \"de\"\n  ],\n  \"permissions\": {\n    \"create_upload\": true,\n    \"review_translations\": true\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "acbdacbdacbdacbdacbdacbd",
  "email": "foo@bar.com",
  "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"
    }
  ]
}

{
  "message": "Validation Failed",
  "errors": [
    {
      "resource": "Resource",
      "field": "name",
      "message": "can't be blank"
    }
  ]
}

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

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:

"example@mail.com"

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

Show child attributes

Example:

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

Response

Created

string

role

string

state

string

projects

project_short · object[]

Show child attributes

locales

locale_preview · object[]

Show child attributes

teams

team_short · object[]

Show child attributes

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_roles

object[]

Per-project roles assigned to the invitee.

Show child attributes

List invitations Get a single invitation

⌘I

Guides

API Documentation

Authorizations

Headers

Path Parameters

Body

Response