Create A Merge Proposal
Record a request to merge a source branch into a target branch. Anyone with edit access can open one; merging it later is gated on write access to the target branch, so this is how a change reaches a protected branch the author cannot merge into themselves.
Path parameters
agent_id
The id of an agent. This is returned on agent creation.
Headers
xi-api-key
Request
This endpoint expects an object.
source_branch_id
Branch whose changes should be merged.
target_branch_id
Branch that should receive the changes.
title
Short title for the merge_proposal.
description
Optional longer description for reviewers.
requested_reviewer_user_ids
User IDs to request a review from.
triage_ticket_id
Triage ticket of this agent that the merge_proposal resolves. Merging it resolves the ticket if still open.
Response
Successful Response
created_merge_proposal_id
ID of the created merge_proposal
Errors
422
Unprocessable Entity Error