Skip to content
wrktr docs

Close a branch

POST
/api/orgs/{org}/projects/{project}/branches/close
curl --request POST \
  --url https://api.wrktr.com/api/orgs/example/projects/example/branches/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "example" }'

Sets the branch aside without landing it: it leaves the branches in progress, its agents and checks stop, and Land refuses it. Its ref, history, description, reviews and threads stay; reopen it to carry on.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string
project
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch
required
string
Examplegenerated
{
  "branch": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
ok
required
boolean
Examplegenerated
{
  "ok": true
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
_tag
required
string
Allowed values: Unauthorized
message
required
string
Example
{
  "_tag": "Unauthorized"
}

404

Section titled “404”

ProjectNotFound | BranchNotFound

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ProjectNotFound
project
required
string
Example
{
  "_tag": "ProjectNotFound"
}

422

Section titled “422”

InvalidInput

Media typeapplication/json
object
_tag
required
string
Allowed values: InvalidInput
message
required
string
Example
{
  "_tag": "InvalidInput"
}