Create merge request with the GitLab API

Opens a merge request from source_branch into target_branch and returns it, with its iid. A title that starts with Draft: opens it as a draft. Notifies the assignees and reviewers.

Identifier
gitlab_create_merge_request

The request

POST https://connect.reportei.com/api/tools/gitlab_create_merge_request/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": "<id>",
    "title": "<title>",
    "source_branch": "<source_branch>",
    "target_branch": "<target_branch>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
idstringYesThe id of the project from List projects, or its path_with_namespace, such as group/project.
titlestringYesTitle of the merge request.
source_branchstringYesBranch with the changes.
target_branchstringYesBranch that receives the changes, such as main.
descriptionstringNoDescription of the merge request, in Markdown.
assignee_idsarrayNoIds of the users to assign, from List project members.
reviewer_idsarrayNoIds of the users to ask for review, from List project members.
labelsarrayNoLabel names. A name that does not exist yet becomes a new label of the project.
milestonestringNoTitle of a milestone of the project or of its groups.
remove_source_branchbooleanNoDeletes the source branch when the merge request is merged.
squashbooleanNoSquashes the commits into one on merge. Without it, the project setting decides.
allow_collaborationbooleanNoLets the members who can merge into the target branch push to the source branch of a fork.

Supported connections

Your customer connects their GitLab account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/gitlab, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/gitlab_create_merge_request. It becomes your agent's tool definition with no conversion.

Other GitLab tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.