Branches

Rebase a branch onto a different parent branch (as a new branch)

Replays this branch’s changes onto a different base and returns the result as a NEW branch; the branch named in the path is not modified. The copy keeps this branch’s value for every field it changed and resolves every field it did not from the new base. Changes to items the new base does not have cannot appear on the copy: relationships to them are left out, and the items are listed in missing_items. The copy carries this branch’s own comments, re-keyed to the copy, except a thread on an item the new base does not have and a reply to a thread that is not in the copy’s lineage; a comment inherited from the old base stays there. Its sub-branches, baselines, and reviews are not copied. Refuses with 400 for the Base branch, a malformed id, a missing newParentId, or a target equal to the branch itself; 404 when either branch is not live in this project.

POST

project

{projectId}

branch

{id}

rebase-onto

Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "missing_item_count": 123,
  "missing_items": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "number": 123
}

Authorizations

X-API-Key

string

header

required

Headers

customer

string

required

Workspace identifier

Path Parameters

projectId

string

required

Project UUID, not a slug. Resolve a slug with GET /project/slug/{slug} using the same workspace and credentials, then pass the returned id.

string

required

Body

application/json

newParentId

string | null

required

Branch id to replay this branch onto. null (or "master") = the project Base.

name

string

Name for the new branch. Defaults to " (rebased)".

Response

200 - application/json

string

required

missing_item_count

number

required

How many such items there are in total.

missing_items

object[]

required

Items this branch changes or links to that the new base does not have, so those changes do not appear on the new branch. Lists at most 50, in the order the branch first changed them.

Show child attributes

number

required

Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "missing_item_count": 123,
  "missing_items": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "number": 123
}

Quickstart

Automations

Flow MCP

Endpoints

Rebase a branch onto a different parent branch (as a new branch)

Authorizations

Headers

Path Parameters

Body

Response