Add an emoji reaction to an item | Sample

1 parameter · 3 body fields

tokenstringrequired

Authentication token with the `reactions:write` scope.

Form data identifying the target message and the emoji reaction to add.

channelstringrequired

Channel where the message to add reaction to was posted.

namestringrequired

Reaction (emoji) name.

timestampstringrequired

Timestamp of the message to add reaction to.

2 status codes

200Returns an object with `ok` set to true confirming that the reaction was added.

okbooleanrequired

Allowed:true

defaultReturned when the target message or channel cannot be found, the reaction name is invalid or already present, reaction limits are exceeded, or authentication, permission, or request arguments are invalid; the response includes `ok` set to false and an `error` reason.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:bad_timestampmessage_not_foundno_item_specifiedinvalid_namealready_reactedtoo_many_emojitoo_many_reactionsnot_authedinvalid_authaccount_inactiveno_permissioninvalid_arg_name

okbooleanrequired

Allowed:false

Error handling

The token must include the reactions:write scope, and channel, name, and timestamp are all required. name must identify a valid reaction, while timestamp must identify the target message in the specified channel.

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

{
  "ok": true
}

Request

Response

Errors