Delete a file comment | Sample

1 parameter · 2 body fields

tokenstringoptional

Authentication token with the `files:write:user` scope.

File comment deletion data containing the file and comment identifiers.

filestringoptional

File to delete a comment from.

idstringoptional

The comment to delete.

2 status codes

200Returns `ok: true` after the file comment has been deleted.

okbooleanrequired

Allowed:true

defaultReturned when the comment cannot be deleted or found, or when authentication, permissions, account status, argument names, or request encoding is invalid.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:cant_deletecomment_not_foundnot_authedinvalid_authaccount_inactiveno_permissioninvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_typemissing_post_type

okbooleanrequired

Allowed:false

Error handling

token must provide authentication with the files:write:user scope. Supply both file and id so the API can identify the file comment to delete.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.filesCommentsDelete.create({
  file: "example",
  id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{
  "ok": true
}

Request

Response

Errors