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'

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

Branches

Merge a branch

Merge an existing branch back into its base branch.

The merge runs asynchronously. The branch transitions to merging_branch and settles in merged, merge_error, or merge_conflict once the background job completes; the response body for this request is empty. Poll the branch resource to observe the final state.

A branch cannot be merged while it still has open jobs or open translation orders attached to its branch project — in that case the request is rejected with 409 Conflict. A branch whose current state does not allow a merge is rejected with 422 Unprocessable Entity.

Requires the Branching feature to be enabled on the account.

Note: Merging a branch may take several minutes depending on diff size.

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'

{
  "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.

Update a branch Sync a branch