cURL

curl "https://api.phrase.com/v2/projects/:project_id/branches/:name/sync" \
  -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

Sync a branch

Pull changes from the base branch into this branch, applying the chosen conflict-resolution strategy.

The sync runs asynchronously. The branch transitions to syncing_branch and settles back into success (or merge_conflict / branch_error) once the background job completes; the response body for this request is empty. Poll the branch resource to observe the final state.

Only branches created with the newer branching system can be synced. Requests against branches from the older system, or against branches whose current state does not allow a sync, are rejected with 422 Unprocessable Entity and an empty body.

Requires the Branching feature to be enabled on the account.

PATCH

projects

{project_id}

branches

{name}

sync

cURL

curl "https://api.phrase.com/v2/projects/:project_id/branches/:name/sync" \
  -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 this branch.

Available options:

use_main,

use_branch

Example:

"use_main"

Response

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

Merge a branch Compare branches