> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update branch status check

> Create or replace one named status check on a branch.

`updateBranchStatusCheck(branchId: ID!, checkName: String!, input: UpdateBranchStatusCheckInput!): BranchStatusCheck!`

Requires project.files.write.

## Arguments

| Argument | Type | Required | Description |
| - | - | - | - |
| `branchId` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Yes | Branch the check reports on. A missing branch and one the caller cannot read are both not found. |
| `checkName` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Yes | Check name; the key of the check on its branch. |
| `input` | [`UpdateBranchStatusCheckInput!`](https://veryfront.com/docs/cloud/graphql/types/updatebranchstatuscheckinput) | Yes | |

## Input fields

### input

[`UpdateBranchStatusCheckInput`](https://veryfront.com/docs/cloud/graphql/types/updatebranchstatuscheckinput)

| Field | Type | Required | Description |
| - | - | - | - |
| `status` | [`StatusCheckStatus!`](https://veryfront.com/docs/cloud/graphql/types/statuscheckstatus) | Yes | State to report. |
| `description` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No | Description of the result, at most 1000 characters. |
| `externalUrl` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No | Link to the external result; a URL of at most 2000 characters. |

## Response

Returns [`BranchStatusCheck!`](https://veryfront.com/docs/cloud/graphql/types/branchstatuscheck). Open the type for its fields and nested types.

| Field | Type |
| - | - |
| `id` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) |
| `branchId` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) |
| `checkName` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) |
| `status` | [`StatusCheckStatus!`](https://veryfront.com/docs/cloud/graphql/types/statuscheckstatus) |
| `description` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) |
| `externalUrl` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) |
| `startedAt` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) |
| `completedAt` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) |

[All fields of `BranchStatusCheck`](https://veryfront.com/docs/cloud/graphql/types/branchstatuscheck).

Types marked with `!` cannot be null. Lists use `[Type]` notation. The [type index](https://veryfront.com/docs/cloud/graphql/schema.md) lists all published input and response types.

## Example

```graphql title="query.graphql" theme={null}
mutation UpdateBranchStatusCheck($branchId: ID!, $checkName: String!, $input: UpdateBranchStatusCheckInput!) {
  updateBranchStatusCheck(branchId: $branchId, checkName: $checkName, input: $input) {
    id
    status
    createdAt
    updatedAt
    branchId
  }
}
```

```json title="variables.json" theme={null}
{
  "branchId": "00000000-0000-4000-8000-000000000001",
  "checkName": "example",
  "input": {
    "status": "pending"
  }
}
```

<details>
  <summary>Try this mutation</summary>

  Calls use `https://api.veryfront.com/graphql`. Replace sample values with resources you can access. See [Authentication](https://veryfront.com/docs/cloud/authentication.md) for credentials and permissions.

  Bearer token or API key

  Stored in this tab's session. Clear credential

  Mutation

  Variables (JSON)
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.