Create branch approval

http
POST /projects/{project_reference}/branches/{branch_id}/approvals

Approve a branch as the calling user, optionally with a comment. Requires project.files.write.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyAuth": []
  }
]
json
{
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "JWT or API Key",
    "description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
  },
  "apiKeyAuth": {
    "type": "apiKey",
    "in": "header",
    "name": "X-API-Key",
    "description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
  }
}

Parameters

NameLocationRequiredDescription
project_referencepathYesProject slug, UUID, or domain that identifies the project.
branch_idpathYes

Parameter contracts

json
[
  {
    "schema": {
      "$ref": "#/components/schemas/ProjectReference"
    },
    "required": true,
    "description": "Project slug, UUID, or domain that identifies the project.",
    "name": "project_reference",
    "in": "path"
  },
  {
    "schema": {
      "type": "string",
      "format": "uuid",
      "description": "Branch UUID belonging to the selected project. Missing or foreign branches return 404."
    },
    "required": true,
    "name": "branch_id",
    "in": "path"
  }
]

Request body

json
{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "comment": {
            "type": "string",
            "description": "Approval comment."
          }
        }
      },
      "example": {
        "comment": "LGTM"
      }
    }
  }
}

Responses

201

Approval created.

json
{
  "description": "Approval created.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Approval ID."
          },
          "branch_id": {
            "type": "string",
            "format": "uuid",
            "description": "Approved branch."
          },
          "approved_by": {
            "type": "string",
            "format": "uuid",
            "description": "User who approved."
          },
          "approved_at": {
            "type": "string",
            "description": "Approval time; kept after dismissal."
          },
          "comment": {
            "type": [
              "string",
              "null"
            ],
            "description": "Approval comment, or null."
          },
          "dismissed_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "Dismissal time, or null while the approval counts."
          },
          "dismissed_by": {
            "type": [
              "string",
              "null"
            ],
            "format": "uuid",
            "description": "User who dismissed the approval, or null."
          },
          "dismissed_reason": {
            "type": [
              "string",
              "null"
            ],
            "description": "Dismissal reason, or null."
          }
        },
        "required": [
          "id",
          "branch_id",
          "approved_by",
          "approved_at",
          "comment",
          "dismissed_at",
          "dismissed_by",
          "dismissed_reason"
        ]
      },
      "example": {
        "id": "2e3d4c5b-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
        "branch_id": "0f6d3c1e-2a4b-4c8d-9e7f-1a2b3c4d5e6f",
        "approved_by": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "approved_at": "2026-10-10T12:00:00.000Z",
        "comment": "LGTM",
        "dismissed_at": null,
        "dismissed_by": null,
        "dismissed_reason": null
      }
    }
  }
}

400

Bad request

json
{
  "description": "Bad request",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

Unauthorized

json
{
  "description": "Unauthorized",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

403

Forbidden

json
{
  "description": "Forbidden",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

404

Not found

json
{
  "description": "Not found",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

409

Conflict

json
{
  "description": "Conflict",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

413

Payload too large

json
{
  "description": "Payload too large",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

500

Server error

json
{
  "description": "Server error",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

503

internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.

json
{
  "description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

Referenced contracts

components/parameters/ProjectReference

json
{
  "schema": {
    "$ref": "#/components/schemas/ProjectReference"
  },
  "required": true,
  "description": "Project slug, UUID, or domain that identifies the project.",
  "name": "project_reference",
  "in": "path"
}

components/schemas/ProjectReference

json
{
  "type": "string"
}

components/schemas/Problem

json
{
  "type": "object",
  "properties": {
    "cause": {
      "type": "string",
      "enum": [
        "schedule_concurrency_forbidden",
        "schedule_fire_in_progress",
        "schedule_run_limit_reached"
      ],
      "description": "Schedule admission refusal."
    },
    "idempotency": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "in_progress",
            "payload_mismatch",
            "outcome_unknown"
          ]
        },
        "operation": {
          "type": "string",
          "minLength": 1
        },
        "retryable": {
          "type": "boolean"
        },
        "retry_after_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "recovery": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "description": {
              "type": "string"
            },
            "resource_url": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "description"
          ]
        }
      },
      "required": [
        "state",
        "operation",
        "retryable",
        "retry_after_seconds",
        "expires_at"
      ],
      "description": "Replay status, retry timing, and recovery lookup."
    },
    "type": {
      "type": "string",
      "description": "URI reference identifying the problem type",
      "example": "https://api.veryfront.com/errors/validation-failed"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable summary of the problem",
      "example": "Validation Failed"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "description": "HTTP status code",
      "example": 400
    },
    "code": {
      "type": "string",
      "description": "Stable machine-readable error code",
      "example": "RUN_INVALID_INPUT"
    },
    "detail": {
      "type": "string",
      "description": "Human-readable explanation specific to this occurrence",
      "example": "The 'email' field must be a valid email address"
    },
    "instance": {
      "type": "string",
      "description": "URI reference identifying the specific occurrence",
      "example": "/projects/my-project/members"
    },
    "slug": {
      "type": "string",
      "description": "Stable identifier for the problem type",
      "example": "validation-failed"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTH",
        "RESOURCE",
        "VALIDATION",
        "DATABASE",
        "SUBSCRIPTION",
        "INTEGRATION",
        "INTERNAL"
      ],
      "description": "API error category",
      "example": "VALIDATION"
    },
    "suggestion": {
      "type": "string",
      "description": "Suggested action to resolve the problem",
      "example": "Check the request body and query parameters against the API documentation."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Field path that caused the error",
            "example": "email"
          },
          "message": {
            "type": "string",
            "description": "Error message for this field",
            "example": "Invalid email format"
          },
          "code": {
            "type": "string",
            "description": "Error code for this field",
            "example": "INVALID_FORMAT"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Detailed field-level errors for validation failures"
    }
  },
  "required": [
    "type",
    "title",
    "status"
  ]
}

Operation contract

json
{
  "operationId": "createBranchApproval",
  "tags": [
    "projects/Branches/Branch Approvals"
  ],
  "summary": "Create branch approval",
  "description": "Approve a branch as the calling user, optionally with a comment. Requires project.files.write.",
  "parameters": [
    {
      "$ref": "#/components/parameters/ProjectReference"
    },
    {
      "schema": {
        "type": "string",
        "format": "uuid",
        "description": "Branch UUID belonging to the selected project. Missing or foreign branches return 404."
      },
      "required": true,
      "name": "branch_id",
      "in": "path"
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "comment": {
              "type": "string",
              "description": "Approval comment."
            }
          }
        },
        "example": {
          "comment": "LGTM"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Approval created.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid",
                "description": "Approval ID."
              },
              "branch_id": {
                "type": "string",
                "format": "uuid",
                "description": "Approved branch."
              },
              "approved_by": {
                "type": "string",
                "format": "uuid",
                "description": "User who approved."
              },
              "approved_at": {
                "type": "string",
                "description": "Approval time; kept after dismissal."
              },
              "comment": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Approval comment, or null."
              },
              "dismissed_at": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Dismissal time, or null while the approval counts."
              },
              "dismissed_by": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "uuid",
                "description": "User who dismissed the approval, or null."
              },
              "dismissed_reason": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Dismissal reason, or null."
              }
            },
            "required": [
              "id",
              "branch_id",
              "approved_by",
              "approved_at",
              "comment",
              "dismissed_at",
              "dismissed_by",
              "dismissed_reason"
            ]
          },
          "example": {
            "id": "2e3d4c5b-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
            "branch_id": "0f6d3c1e-2a4b-4c8d-9e7f-1a2b3c4d5e6f",
            "approved_by": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
            "approved_at": "2026-10-10T12:00:00.000Z",
            "comment": "LGTM",
            "dismissed_at": null,
            "dismissed_by": null,
            "dismissed_reason": null
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "404": {
      "description": "Not found",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "409": {
      "description": "Conflict",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "413": {
      "description": "Payload too large",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "503": {
      "description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Branch Approvals",
  "x-canonical-documentation": {
    "domain": "projects",
    "resource": "Branches",
    "subgroup": "Branch Approvals",
    "name": "Create branch approval",
    "description": "Approve a branch as the calling user, optionally with a comment. Requires project.files.write.",
    "operationId": "createBranchApproval"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/projects-branches-branch-approvals/create-branch-approval"
  }
}