Skip to main content
PATCH
Update a repo sync

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

id
string
required

ID

Body

application/json
name
string

Display name for the repo sync.

owner_id
string

Code of the user to assign as owner. Requires manage_github_sync? permission on the project; returns 403 if not satisfied.

export_triggers
enum<string>[]

Replaces the current set of automatic export triggers. Requires manage_github_sync? permission on the project and the automatic export feature to be enabled for the account. Accepted values: schedule, branch_merged, job_completed.

Available options:
schedule,
branch_merged,
job_completed
export_schedule
object

Updates the schedule for automatic exports. Only applied when export_triggers includes schedule. Requires manage_github_sync? permission and the automatic export feature to be enabled.

Response

OK

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
owner
user_short · object
Example:
export_triggers
enum<string>[]

Events that trigger an automatic export. Only present when the automatic export feature is enabled for the account. Possible values: schedule (runs on the configured schedule), branch_merged (runs when a branch is merged in the connected repository), job_completed (runs when a translation job completes in the project).

Available options:
schedule,
branch_merged,
job_completed
export_schedule
object | null

Schedule configuration for automatic exports. Only present when the automatic export feature is enabled for the account. null when the schedule trigger is not active.