Dismiss branch approval

dismissBranchApproval(approvalId: ID!, input: DismissBranchApprovalInput): BranchApproval!

Requires project.files.write; API keys also need delete scope.

Arguments

ArgumentTypeRequiredDescription
approvalIdID!YesApproval to dismiss. A missing approval and one the caller cannot read are both not found.
inputDismissBranchApprovalInputNo

Input fields

input

DismissBranchApprovalInput

FieldTypeRequiredDescription
reasonStringNoReason for the dismissal, at most 1000 characters.

Response

Returns BranchApproval!. Open the type for its fields and nested types.

FieldType
idID!
branchIdID!
approvedByID!
approvedAtString!
commentString
dismissedAtString
dismissedByID
dismissedReasonString

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation DismissBranchApproval($approvalId: ID!, $input: DismissBranchApprovalInput) {
  dismissBranchApproval(approvalId: $approvalId, input: $input) {
    id
    approvedAt
    approvedBy
    branchId
    comment
  }
}
json
{
  "approvalId": "00000000-0000-4000-8000-000000000001"
}