> ## 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.

# Create branch approval

> Approve a branch as the calling user, optionally with a comment.

`createBranchApproval(branchId: ID!, input: CreateBranchApprovalInput): BranchApproval!`

Requires project.files.write.

## Arguments

| Argument | Type | Required | Description |
| - | - | - | - |
| `branchId` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Yes | Branch to approve. A missing branch and one the caller cannot read are both not found. |
| `input` | [`CreateBranchApprovalInput`](https://veryfront.com/docs/cloud/graphql/types/createbranchapprovalinput) | No | |

## Input fields

### input

[`CreateBranchApprovalInput`](https://veryfront.com/docs/cloud/graphql/types/createbranchapprovalinput)

| Field | Type | Required | Description |
| - | - | - | - |
| `comment` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No | Approval comment, at most 1000 characters. |

## Response

Returns [`BranchApproval!`](https://veryfront.com/docs/cloud/graphql/types/branchapproval). 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) |
| `approvedBy` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) |
| `approvedAt` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) |
| `comment` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) |
| `dismissedAt` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) |
| `dismissedBy` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) |
| `dismissedReason` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) |

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 CreateBranchApproval($branchId: ID!, $input: CreateBranchApprovalInput) {
  createBranchApproval(branchId: $branchId, input: $input) {
    id
    approvedAt
    approvedBy
    branchId
    comment
  }
}
```

```json title="variables.json" theme={null}
{
  "branchId": "00000000-0000-4000-8000-000000000001"
}
```

<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.