GitButler Logo
API Reference

Chat Messages

Operations about chat_messages

GET
/chat_messages/{project_id}/chats/{change_id}

Get Chat Messages Project Id Chats Change Id

Get chat messages for a patch

/chat_messages/{project_id}/chats/{change_id}

Path Parameters

project_id
Required
string

Repository ID

change_id
Required
string

Change Id

Query Parameters

beforestring

Before timestamp

Format: "date-time"

sincestring

Since timestamp

Format: "date-time"

issuesstring

Open or closed issues

Value in: "open" | "closed" | "all"
curl -X GET "https://app.gitbutler.com/api/chat_messages/string/chats/string?before=2019-08-24T14%3A15%3A22Z&since=2019-08-24T14%3A15%3A22Z&issues=open"

Get chat messages for a patch

{
  "uuid": "string",
  "user": {
    "id": "string",
    "login": "string",
    "name": "string",
    "email": "string",
    "avatar_url": "string"
  },
  "outdated": "string",
  "issue": "string",
  "resolved": "string",
  "thread_id": "string",
  "comment": "string",
  "diff_sha": "string",
  "range": "string",
  "diff_path": "string",
  "diff_patch_array": "string",
  "created_at": "string",
  "updated_at": "string"
}

GET
/chat_messages/{project_id}/chat/{chat_uuid}

Get Chat Messages Project Id Chat Chat Uuid

Get chat message

/chat_messages/{project_id}/chat/{chat_uuid}

Path Parameters

project_id
Required
string

Repository ID

chat_uuid
Required
string

Chat UUID

curl -X GET "https://app.gitbutler.com/api/chat_messages/string/chat/string"

Get chat message

{
  "uuid": "string",
  "user": {
    "id": "string",
    "login": "string",
    "name": "string",
    "email": "string",
    "avatar_url": "string"
  },
  "outdated": "string",
  "issue": "string",
  "resolved": "string",
  "thread_id": "string",
  "comment": "string",
  "diff_sha": "string",
  "range": "string",
  "diff_path": "string",
  "diff_patch_array": "string",
  "created_at": "string",
  "updated_at": "string"
}

PATCH
/chat_messages/{project_id}/chat/{chat_uuid}

Patch Chat Messages Project Id Chat Chat Uuid

Update chat message

/chat_messages/{project_id}/chat/{chat_uuid}

Request Body

application/jsonRequired

resolved
Required
boolean

Chat message issue is resolved

Default: false

Path Parameters

project_id
Required
string

Repository ID

chat_uuid
Required
string

Chat UUID

curl -X PATCH "https://app.gitbutler.com/api/chat_messages/string/chat/string" \
  -H "Content-Type: application/json" \
  -d '{
    "resolved": false
  }'

Update chat message

{
  "uuid": "string",
  "user": {
    "id": "string",
    "login": "string",
    "name": "string",
    "email": "string",
    "avatar_url": "string"
  },
  "outdated": "string",
  "issue": "string",
  "resolved": "string",
  "thread_id": "string",
  "comment": "string",
  "diff_sha": "string",
  "range": "string",
  "diff_path": "string",
  "diff_patch_array": "string",
  "created_at": "string",
  "updated_at": "string"
}

DELETE
/chat_messages/{project_id}/chat/{chat_uuid}

Delete Chat Messages Project Id Chat Chat Uuid

Delete chat message

/chat_messages/{project_id}/chat/{chat_uuid}

Path Parameters

project_id
Required
string

Repository ID

chat_uuid
Required
string

Chat UUID

curl -X DELETE "https://app.gitbutler.com/api/chat_messages/string/chat/string"

Delete chat message

{
  "uuid": "string",
  "user": {
    "id": "string",
    "login": "string",
    "name": "string",
    "email": "string",
    "avatar_url": "string"
  },
  "outdated": "string",
  "issue": "string",
  "resolved": "string",
  "thread_id": "string",
  "comment": "string",
  "diff_sha": "string",
  "range": "string",
  "diff_path": "string",
  "diff_patch_array": "string",
  "created_at": "string",
  "updated_at": "string"
}

POST
/chat_messages/{project_id}/branch/{branch_id}

Post Chat Messages Project Id Branch Branch Id

Create new chat message

/chat_messages/{project_id}/branch/{branch_id}

Request Body

application/jsonRequired

chat
Required
string

Chat message

change_idstring

Change ID

thread_idstring

UUID of chat thread

issueboolean

This comment is an issue

Default: false

diff_pathstring

Path of patch file to comment on

diff_shastring

SHA of Diff to comment on

rangestring

Range of Diff to comment on (ex: L15 or L15-R50)

Path Parameters

project_id
Required
string

Repository ID

branch_id
Required
string

Branch ID

curl -X POST "https://app.gitbutler.com/api/chat_messages/string/branch/string" \
  -H "Content-Type: application/json" \
  -d '{
    "chat": "string",
    "change_id": "string",
    "thread_id": "string",
    "issue": false,
    "diff_path": "string",
    "diff_sha": "string",
    "range": "string"
  }'

Create new chat message

{
  "uuid": "string",
  "user": {
    "id": "string",
    "login": "string",
    "name": "string",
    "email": "string",
    "avatar_url": "string"
  },
  "outdated": "string",
  "issue": "string",
  "resolved": "string",
  "thread_id": "string",
  "comment": "string",
  "diff_sha": "string",
  "range": "string",
  "diff_path": "string",
  "diff_patch_array": "string",
  "created_at": "string",
  "updated_at": "string"
}

Previous

Debugging

Next

Downloads