v1

latestOpenAPI 3.0.02026-07-14169146300.3 KB

Environments

Update database branch config

Updates the configuration of the specified database branch

patch/v1/branches/{branch_id_or_ref}

Path parameters

string required

Project ref

string uuid required

Example:abcdefghijklmnopqrst

Branch ref or deprecated branch ID

Request body

branch_namestring

git_branchstring

reset_on_pushboolean

This field is deprecated and will be ignored. Use v1-reset-a-branch endpoint directly instead.

persistentboolean

request_reviewboolean

notify_urlstring uri

HTTP endpoint to receive branch status updates.

Example request

{
  "branch_name": "preview-login-page",
  "git_branch": "feature/login-page",
  "persistent": true,
  "request_review": true,
  "notify_url": "https://example.com/webhooks/branches"
}

Response

idstring uuid required

namestring required

project_refstring required

parent_project_refstring required

is_defaultboolean required

git_branchstring

pr_numberinteger

latest_check_run_idnumber

This field is deprecated and will not be populated.

persistentboolean required

This field is deprecated. List action runs to get branch status instead.

created_atstring date-time required

updated_atstring date-time required

review_requested_atstring date-time

with_databoolean required

notify_urlstring uri

deletion_scheduled_atstring date-time