Update issue with the GitLab API

Changes an issue and returns it. Only the fields sent change, and at least one must be sent. To close or reopen it, send state_event. labels replaces all the labels; add_labels and remove_labels change only the ones named.

Identifier
gitlab_update_issue

The request

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": "<id>",
    "issue_iid": 1
  }
}

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. In List issues it is the project_id of the issue.
issue_iidintegerYesThe iid of the issue from List project issues or List issues, not its id.
titlestringNoNew title.
descriptionstringNoNew content, in Markdown.
state_eventstringNoCloses or reopens the issue.Values: close, reopen
assignee_idsarrayNoIds of the users the issue should be assigned to, from List project members, replacing the current ones. Send [0] to remove all.
labelsarrayNoLabel names that replace all the current ones.
add_labelsarrayNoLabel names to add. A name that does not exist yet becomes a new label of the project.
remove_labelsarrayNoLabel names to remove.
milestonestringNoTitle of a milestone of the project or of its groups.
due_datestringNoDue date, as YYYY-MM-DD.
confidentialbooleanNoMakes the issue confidential, or public again with false.

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_update_issue. 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.