Delete a branch

POST

/api/orgs/{org}/projects/{project}/branches/delete

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

Deletes the branch on the remote if it hasn’t moved since you looked. Never the default branch. Its review history stays.

Authorizations

• bearer

Parameters

Path Parameters

org

required

string

project

required

string

Request Body^required

Media typeapplication/json

object

branch

required

string

Example^generated

{
  "branch": "example"
}

Responses

200

Success

Media typeapplication/json

object

ok

required

boolean

Example^generated

{
  "ok": true
}

401

Unauthorized

Media typeapplication/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound | BranchNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ProjectNotFound

project

required

string

object

object

_tag

required

string

Allowed values: BranchNotFound

project

required

string

branch

required

string

Example

{
  "_tag": "ProjectNotFound"
}

409

BranchMoved

Media typeapplication/json

object

_tag

required

string

Allowed values: BranchMoved

branch

required

string

expectedHead

required

string

currentHead

required

string

Example

{
  "_tag": "BranchMoved"
}

422

InvalidInput

Media typeapplication/json

object

_tag

required

string

Allowed values: InvalidInput

message

required

string

Example

{
  "_tag": "InvalidInput"
}