Skip to main content
POST
Upsert Branch Status Check

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required
branchId
string<uuid>
required

Branch ID (UUID)

Body

application/json
check_name
string
required
status
enum<string>
required
Available options:
pending,
success,
failure
description
string
external_url
string

Response

Status check updated

id
string<uuid>
required
branch_id
string<uuid>
required
check_name
string
required
status
enum<string>
required
Available options:
pending,
success,
failure
description
string | null
required
external_url
string | null
required
created_at
string
required
updated_at
string
required