Create a merge request discussion

POST

/api/v4/projects/{id}/merge_requests/{noteable_id}/discussions

• GitLab REST API

Creates a discussion for a specified merge request. Replies can be added to it later.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

string

The ID of a project

noteable_id

required

integer

The ID of the merge request

Request Body ^required

Media type application/json

object

body

required

The content of a note

string

nullable

created_at

The creation date of the note

string

nullable

position

Position when creating a note

object

base_sha

required

Base commit SHA in the source branch

string

nullable

start_sha

required

SHA referencing commit in target branch

string

nullable

head_sha

required

SHA referencing HEAD of this merge request

string

nullable

position_type

required

Type of the position reference

string

>= 1 characters

Allowed values: text image file

new_path

File path after change

string

nullable

new_line

Line number after change

integer

nullable

old_path

File path before change

string

nullable

old_line

Line number before change

integer

nullable

width

Width of the image

integer

nullable

height

Height of the image

integer

nullable

x

X coordinate in the image

integer

nullable

y

Y coordinate in the image

integer

nullable

line_range

Multi-line start and end

object

start

Start line for a multi-line note

object

line_code

Start line code for multi-line note

string

nullable

type

Start line type for multi-line note

string

nullable

old_line

Start old_line line number

integer

nullable

new_line

Start new_line line number

integer

nullable

end

End line for a multi-line note

object

line_code

End line code for multi-line note

string

nullable

type

End line type for multi-line note

string

nullable

old_line

End old_line line number

integer

nullable

new_line

End new_line line number

integer

nullable

Responses

201

Created

Media type application/json

object

id

string

individual_note

boolean

resolvable

boolean

resolved

boolean

notes

object

id

integer format: int64

type

string

body

string

author

object

id

integer format: int64

username

string

public_email

string

name

string

state

string

locked

boolean

avatar_url

string

avatar_path

string

custom_attributes

Array<object>

object

key

string

value

string

web_url

string

created_at

string format: date-time

updated_at

string format: date-time

system

boolean

noteable_id

integer format: int64

noteable_type

string

project_id

integer format: int64

commit_id

string

position

object

resolvable

boolean

resolved

boolean

resolved_by

object

id

integer format: int64

username

string

public_email

string

name

string

state

string

locked

boolean

avatar_url

string

avatar_path

string

custom_attributes

Array<object>

object

key

string

value

string

web_url

string

resolved_at

string format: date-time

suggestions

object

id

integer format: int64

from_line

integer

to_line

integer

appliable

boolean

applied

boolean

from_content

string

to_content

string

confidential

boolean

internal

boolean

imported

boolean

imported_from

string

noteable_iid

integer

commands_changes

object

Example

{
  "id": "6a9c1750b37d513a43987b574953fceb50b03ce7",
  "individual_note": false,
  "notes": {
    "id": 1,
    "type": "DiscussionNote",
    "body": "Note body.",
    "author": {
      "id": 1,
      "username": "admin",
      "public_email": "john@example.com",
      "name": "Administrator",
      "state": "active",
      "avatar_url": "https://gravatar.com/avatar/1",
      "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
      "custom_attributes": [
        {
          "key": "foo",
          "value": "bar"
        }
      ],
      "web_url": "https://gitlab.example.com/root"
    },
    "created_at": "2022-01-31T15:10:44.988Z",
    "updated_at": "2022-01-31T15:10:44.988Z",
    "system": false,
    "noteable_id": 1,
    "noteable_type": "Issue",
    "project_id": 1,
    "commit_id": "7b09ce7e6f80347baf0316c8c94cdba9a0a7e91d",
    "resolvable": false,
    "resolved": false,
    "resolved_by": {
      "id": 1,
      "username": "admin",
      "public_email": "john@example.com",
      "name": "Administrator",
      "state": "active",
      "avatar_url": "https://gravatar.com/avatar/1",
      "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
      "custom_attributes": [
        {
          "key": "foo",
          "value": "bar"
        }
      ],
      "web_url": "https://gitlab.example.com/root"
    },
    "resolved_at": "2022-01-31T15:10:44.988Z",
    "suggestions": {
      "id": 1,
      "from_line": 1,
      "to_line": 1,
      "appliable": true,
      "applied": false,
      "from_content": "Original content\n",
      "to_content": "New content\n"
    },
    "confidential": false,
    "internal": false,
    "imported": false,
    "imported_from": "github",
    "noteable_iid": 1
  }
}

400

Bad Request

404

Not Found