Freezes a branch so keys and translations on it cannot change, or makes it active again.
HTTP
PATCH /branches/{branchId}Access: Session token only. API keys get 403 with insufficient_scope.
Role: Project manager (organisation owners and admins are managers of every project).
Path parameters #
| Parameter | Description |
|---|---|
branchId | The id of the branch. |
Request body #
JSON.
| Field | Type | Required | Description |
|---|---|---|---|
frozen | boolean | yes | true to freeze, false to unfreeze. |
JSON
{ "frozen": true }Response 200 #
The branch after the change.
JSON
{
"id": "0197a3c8-6f75-7c66-a9bd-1d5a7e2c4f86",
"projectId": "0197a3c6-4d53-7a44-87fb-9b3e5c0a2d64",
"name": "feature/checkout",
"base": "main",
"status": "active",
"progress": 40,
"progressLabel": "80 / 200",
"openKeys": 30,
"ageMinutes": 15
}Response fields #
| Field | Type | Description |
|---|---|---|
id | string | The id of the branch. |
projectId | string | The id of its project. |
name | string | The name. |
base | string or null | The name of the branch it was made from. null for main. |
status | string | protected (the main branch), active, frozen, or ready when every key is published in every language. |
progress | integer | Percent of published translations over all keys and languages. |
progressLabel | string | The same as a text such as 80 / 200, with thousands separators. |
openKeys | integer | Keys that are not published in every language yet. |
ageMinutes | integer | Minutes since the branch last changed. |
Errors #
| Status | error | When |
|---|---|---|
| 401 | unauthenticated | The token is missing or not valid. |
| 404 | not_found | The branch does not exist, you have no access to its project, or branchId is not a UUID. |
| 403 | forbidden | You are a member of the project, but not a manager. |
| 409 | branch_protected | The branch is the protected main branch. |
| 422 | invalid_request | frozen is not a boolean. |
| 429 | rate_limited | Too many requests, see Rate limiting. |
See Errors for the error format.