---
title: "Add Branch"
method: POST
path: "/projects/{projectId}/branches"
tags: ["Branches"]
---

# Add Branch

`POST /projects/{projectId}/branches`

## Request

- Base URL: `https://api.crowdin.com/api/v2`
- URL: `https://api.crowdin.com/api/v2/projects/{projectId}/branches`
- Auth: none declared
- TypeScript: <https://skmtc.dev/crowdin/apis/crowdin-api-v2/docs/projects/:projectId/branches/post.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

## Request body

- BranchCreateForm
  - `name` string, required: Branch name __Note:__ Can't contain `\ / : * ? " < > |` symbols
  - `title` string: Use to provide more details for translators. Title is available in UI only
  - `isProtected` boolean: If true, the branch is protected from some actions (for example, delete or force-push operations may be restricted)

## Response `201`

Branch was successfully created

- 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 Parameters
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Project with specified id was not found
- `405`: Method Not Allowed
- `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)