Tolgee Octri Demo
POST/v2/projects/{projectId}/branches/merge/{mergeId}/refresh

Refresh a branch merge session preview

Refreshes the preview for a branch merge session. Use this after source or target branch data changes to recalculate the preview before reviewing or applying the merge.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters
mergeIdintegerrequired
The merge session identifier as a 64-bit integer.
projectIdintegerrequired
The project identifier as a 64-bit integer.

5 status codes
200Returns the refreshed merge preview summary, including branch identifiers and names, counts of key changes and conflicts, the `outdated` state, and the count of uncompleted source-branch tasks.
idintegerrequired
Branch merge id
keyAdditionsCountintegerrequired
Key additions count
keyDeletionsCountintegerrequired
Key deletions count
keyModificationsCountintegerrequired
Key updates count
keyResolvedConflictsCountintegerrequired
Key resolved conflicts count
keyUnresolvedConflictsCountintegerrequired
Key unresoled conflicts count
mergedAtintegeroptional
Date of merge. If null, merge was not applied yet
outdatedbooleanrequired
Is merge outdated. If true, it means, that either source or target branch data were changed
sourceBranchIdintegerrequired
Source branch id
sourceBranchNamestringrequired
Source branch name
targetBranchIdintegerrequired
Target branch id
targetBranchNamestringrequired
Target branch name
uncompletedTasksCountintegerrequired
Uncompleted tasks count on source branch
400Returned when the request is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when authentication is missing or invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when you do not have permission to refresh the merge preview.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the project or merge session cannot be found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request is invalid. A 401 is returned when authentication is missing or invalid, a 403 when you lack permission, and a 404 when the project or merge session cannot be found. The mergeId and projectId path parameters must identify the session and its project.