---
title: "Edit Branch"
method: PATCH
path: "/projects/{projectId}/branches/{branchId}"
tags: ["Branches"]
---

# Edit Branch

`PATCH /projects/{projectId}/branches/{branchId}`

## Request

- Base URL: `https://api.crowdin.com/api/v2`
- URL: `https://api.crowdin.com/api/v2/projects/{projectId}/branches/{branchId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/crowdin/apis/crowdin-api-v2/docs/projects/:projectId/branches/:branchId/patch.ts> (a function with typed inputs; its response is checked against the schema)

**Required scopes:** `project.source.file` (Read and Write).

## Path parameters

- `projectId` integer, required
- `branchId` integer, required

## Request body

- BranchOperation[]: A JSON Patch document as defined by <a href="https://tools.ietf.org/html/rfc6902#section-3" target="_blank">RFC 6902</a>
  - `op` 'replace' | 'test', required: Patch operation to perform
  - `path` '/name' | '/title' | '/priority' | '/isProtected', json-pointer, required: A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>

## Response `200`

Branch was successfully updated

- StringBasedBranchResource: Base schema of resource container. Container is a wrapper object that contains payload in required `data` property and provides space for adding any other metadata.
  - `data` StringBasedProjectBranch, required
    - `id` integer
    - `projectId` integer
    - `name` string
    - `title` string
    - `createdAt` string, date-time
    - `updatedAt` string, date-time, nullable
    - `isProtected` boolean

## Other responses

- `400`: Invalid Request Body
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Project or branch with specified id was not found
- `405`: Method Not Allowed
- `500`: Internal Server Error
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crowdin/apis/crowdin-api-v2.md) - [All operations](https://skmtc.dev/crowdin/apis/crowdin-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/crowdin/apis/crowdin-api-v2/revisions/27aae7751699?raw)