Skip to main content
POST
cURL

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
project_id
string
required

ID of the project to connect the Repo Sync to.

Example:

"abcd1234abcd1234abcd1234abcd1234"

connection_type
enum<string>
required

The authentication method used to connect to the Git provider. Defaults to token if not specified.

Valid values:

  • token — Personal access token stored on the Repo Sync. Supported by all providers.
  • github_app — Authenticate via the Phrase GitHub App installation on your account. GitHub only. The account must already have the GitHub App installed; if not, the response will include a github_app_installation_url.
  • self_hosted — Token-based auth for self-hosted Git instances. Requires custom_api_endpoint.
Available options:
token,
github_app,
self_hosted
Example:

"github_app"

repo_name
string
required

Full repository name including the owner, e.g. my-org/my-repo.

Example:

"my-org/my-repo"

name
string | null

Optional custom display name for this repo sync. Defaults to null; when null the project name is used as the display name.

Maximum string length: 100
git_provider
enum<string>
default:github

The Git provider to use.

Available options:
github,
gitlab,
bitbucket
Example:

"github"

base_branch
string

The default branch to use for imports and exports.

Example:

"main"

pr_branch
string

Branch that translations are exported to before opening a pull request. If omitted, exports go directly to base_branch.

Example:

"phrase-translations"

auto_import
boolean

Enable automatic import of translations triggered by pushes to the repository.

Example:

false

access_token
string

Personal access token for the Git provider. Required when connection_type is token or self_hosted. Not used for github_app.

Example:

"ghp_xxxxxxxxxxxxxxxxxxxx"

custom_api_endpoint
string

Custom API endpoint URL for self-hosted Git instances. Required when connection_type is self_hosted.

Example:

"https://git.example.com/api/v4"

Response

Created

id
string
name
string | null

Optional custom display name for this repo sync. When null or blank, the sync is displayed using the associated project name.

Maximum string length: 100
project
project_short · object
Example:
provider
string
enabled
boolean
auto_import
boolean
repo_name
string
pr_branch
string | null

Branch used as the source of exports/PRs. May be null when the sync is configured to push directly to base_branch.

created_at
string<date-time>
last_import_at
string<date-time> | null
last_export_at
string<date-time> | null