Remove a reaction from an item | Sample

1 parameter · 5 body fields

tokenstringrequired

Authentication token with the `reactions:write` scope.

Form-encoded reaction-removal details. Supply name and the fields identifying the message, file, or file comment.

namestringrequired

Reaction (emoji) name.

filestringoptional

File to remove reaction from.

file_commentstringoptional

File comment to remove reaction from.

channelstringoptional

Channel where the message to remove reaction from was posted.

timestampstringoptional

Timestamp of the message to remove reaction from.

2 status codes

200Confirms that the reaction was removed successfully.

okbooleanrequired

Allowed:true

defaultTypical error response

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:bad_timestampfile_not_foundfile_comment_not_foundmessage_not_foundno_item_specifiedinvalid_nameno_reactionnot_authedinvalid_authaccount_inactiveno_permissioninvalid_arg_name

okbooleanrequired

Allowed:false

Error handling

The token must grant the reactions:write scope, and name must identify the reaction to remove. Provide the applicable target using channel and timestamp, file, or file_comment.

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.reactionsRemove.create({
  name: "Untitled",
  file: "example",
  fileComment: "example",
  channel: "example",
  timestamp: "2024-01-15T09:30:00Z",
});

{
  "ok": true
}

Request

Response

Errors