Skip to content
  • Auto
  • Light
  • Dark
Get Started

Create

Create
client.vals.branches.create(stringvalId, BranchCreateParamsbody, RequestOptionsoptions?): idstringcreatedAtstringforkedBranchIdunionlinksLinksnamestringupdatedAtstringversionnumberBranchCreateResponse
post/v2/vals/{val_id}/branches

Create a new branch

Parameters
valIdstring
formatuuid
bodynamestringbranchIdstringBranchCreateParams
Hide ParametersShow Parameters
namestring
minLength1
maxLength48
branchIdstring
optional

The branch ID to fork from. If this is not specified, the new branch will be forked from main.

formatuuid
Returns
BranchCreateResponse

A Branch

Hide ParametersShow Parameters
idstring

The id of the branch

formatuuid
createdAtstring
formatdate-time
forkedBranchIdunion
string | null

The id of the branch this branch was forked from

namestring
updatedAtstring
formatdate-time
versionnumber
minimum0
import ValTown from '@valtown/sdk';

const client = new ValTown();

const branch = await client.vals.branches.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  name: 'my-branch',
  branchId: '00000000-0000-0000-0000-000000000000',
});

console.log(branch.id);
200 Example
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "createdAt": "2019-12-27T18:11:19.117Z",
  "forkedBranchId": "forkedBranchId",
  "links": {
    "html": "https://example.com",
    "self": "https://example.com"
  },
  "name": "name",
  "updatedAt": "2019-12-27T18:11:19.117Z",
  "version": 0
}