Skip to main content
POST
/
projects
/
{project_id}
/
figma_attachments
cURL
curl "https://api.phrase.com/v2/projects/:project_id/figma_attachments" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -F branch=my-feature-branch \
  -F url=https://figma.com/file/xxxxx/sample \
phrase figma_attachment create \
--project_id <project_id> \
--data '{"branch":"my-feature-branch", "url":"https://figma.com/file/xxxxx/sample"}' \
--access_token <token>
import requests

url = "https://api.phrase.com/v2/projects/{project_id}/figma_attachments"

payload = {
"url": "https://figma.com/file/xxxxx/sample",
"branch": "my-feature-branch"
}
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({url: 'https://figma.com/file/xxxxx/sample', branch: 'my-feature-branch'})
};

fetch('https://api.phrase.com/v2/projects/{project_id}/figma_attachments', 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/projects/{project_id}/figma_attachments",
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([
'url' => 'https://figma.com/file/xxxxx/sample',
'branch' => 'my-feature-branch'
]),
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/projects/{project_id}/figma_attachments"

payload := strings.NewReader("{\n \"url\": \"https://figma.com/file/xxxxx/sample\",\n \"branch\": \"my-feature-branch\"\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/projects/{project_id}/figma_attachments")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://figma.com/file/xxxxx/sample\",\n \"branch\": \"my-feature-branch\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.phrase.com/v2/projects/{project_id}/figma_attachments")

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 \"url\": \"https://figma.com/file/xxxxx/sample\",\n \"branch\": \"my-feature-branch\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "626ea67628690c73ac86ac81eec2d185",
  "url": "https://figma.com/file/something",
  "created_at": "2017-01-28T09:52:53Z",
  "updated_at": "2017-01-28T09:52:53Z"
}
{
"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

project_id
string
required

Project ID

Query Parameters

branch
string

specify the branch to use

Body

application/json
url
string
required

Figma file url

Example:

"https://figma.com/file/xxxxx/sample"

branch
string

specify the branch to use

Example:

"my-feature-branch"

Response

Created

id
string
url
string
created_at
string<date-time>
updated_at
string<date-time>