Delete a comment you wrote

DELETE

/v1/issues/{issueId}/comments/{commentId}

curl --request DELETE \
  --url https://api.pealboard.com/v1/issues/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/comments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• production

Only the comment’s own author may delete it. GitHub deletes it outright, so the cached row goes with it; the activity row stays and is the only record that it existed.

Access. Requires the member role or above (member, admin, owner). Deleting a comment writes to the customer’s GitHub repository under their installation. API-key scope: issues:write.

Authorizations

• bearerAuth

Parameters

Path Parameters

issueId

required

From GET /v1/issues.

string format: uuid

From GET /v1/issues.

commentId

required

From GET /v1/issues/{issueId}/comments.

string format: uuid

From GET /v1/issues/{issueId}/comments.

Responses

200

The comment is deleted.

Media typeapplication/json

object

ok

required

boolean

Example

{
  "ok": true
}

401

No valid credentials.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

403

Authenticated, but not permitted.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

404

No such resource, or it is not visible to you.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

409

The request conflicts with the current state.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

422

The request did not match the expected shape.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

429

Rate limited. Retry after the interval in the header.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

502

GitHub or another dependency refused or did not answer. Nothing in the workspace changed.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}