Merge A Merge Proposal

Execute the merge. The caller must have write access to the target branch (admins only, for a protected branch), so this is where a reviewer approves and merges a request opened by someone who could not.

Path parameters

agent_idstringRequired
The id of an agent. This is returned on agent creation.
merge_proposal_idstringRequired

Unique identifier for the merge_proposal.

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
archive_source_branchbooleanOptionalDefaults to true
Whether to archive the source branch after merging.
forcebooleanOptionalDefaults to false

Force source branch changes onto the target, overriding timestamp-based conflict resolution.

Response

Successful Response
idstring
agent_idstring
source_branch_idstring
target_branch_idstring
source_tip_version_id_at_creationstring
titlestring
created_atinteger
updated_atinteger
descriptionstringOptionalDefaults to
requested_reviewer_user_idslist of stringsOptional
reviewslist of objectsOptional
commentslist of objectsOptional
outcomeobjectOptional
author_user_idstring or nullOptional

User ID of the merge_proposal’s author.

access_infoobject or nullOptional

Access information for the merge_proposal, including creator.

Errors

422
Unprocessable Entity Error