Pin an item to a channel | Sample

1 parameter · 2 body fields

tokenstringrequired

Authentication token with the `pins:write` scope.

Form data identifying the channel and item to pin.

channelstringrequired

Channel to pin the item in.

timestampstringoptional

Timestamp of the message to pin.

2 status codes

200Returns an object with `ok` set to true confirming that the item was pinned.

okbooleanrequired

Allowed:true

defaultReturned when the channel or item cannot be found, the item is already pinned or cannot be pinned, 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_foundchannel_not_foundno_item_specifiedalready_pinnedpermission_deniedfile_not_sharednot_pinnablenot_authedinvalid_authaccount_inactiveno_permission

okbooleanrequired

Allowed:false

Error handling

The token must include the pins:write scope, and channel must identify the channel containing the item. Supply timestamp when the item is a message, using the message timestamp rather than a reply timestamp.

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

{
  "ok": true
}

Request

Response

Errors