Skip to main content
PATCH
/
projects
/
{project_id}
/
branches
/
{name}
/
merge
cURL
curl "https://api.phrase.com/v2/projects/:project_id/branches/:name/merge" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X PATCH \
  -d '{"strategy":"use_main"}' \
  -H 'Content-Type: application/json'
phrase branches merge \
--project_id <project_id> \
--name <name> \
--data '{"strategy":"use_main"}' \
--access_token <token>
import requests

url = "https://api.phrase.com/v2/projects/{project_id}/branches/{name}/merge"

payload = { "strategy": "use_main" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({strategy: 'use_main'})
};

fetch('https://api.phrase.com/v2/projects/{project_id}/branches/{name}/merge', 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}/branches/{name}/merge",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'strategy' => 'use_main'
]),
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}/branches/{name}/merge"

payload := strings.NewReader("{\n \"strategy\": \"use_main\"\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://api.phrase.com/v2/projects/{project_id}/branches/{name}/merge")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"strategy\": \"use_main\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"strategy\": \"use_main\"\n}"

response = http.request(request)
puts response.read_body
{
  "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

name
string
required

name

Body

application/json
strategy
enum<string>

Conflict resolution strategy applied when the branch and its base have diverged. use_main keeps the values from the base branch; use_branch keeps the values from the branch being merged.

Available options:
use_main,
use_branch
Example:

"use_main"

Response

OK. The merge has been scheduled. The response body is empty; observe progress by polling the branch resource.