This is reference content about building functions and workflows. Learn more if you're not yet familiar with this new Slack platform paradigm.

add_pin

Pin a message to a channel

Facts

Schema ID

Schema.slack.functions.AddPin

Schema reference

slack#/functions/add_pin

Required scopes

pins:write

Related methods

pins.add

Input parameters

Required parameters

channel_id

Schema.slack.types.channel_id

·Required

The conversation ID for the channel you are pinning the message to

C123ABC456
D123ABC456

message

Schema.types.string

·Required

The URL or message timestamp of the message you are pinning

1355517523.000005
https://workface.slack.com/archives/CAZPFJXGD/p1676920733028759

Output parameters

There are no parameters to display

Usage guide

Pins a message to a channel.

Example workflow step

const addPinStep = ExampleWorkflow.addStep(
  Schema.slack.functions.AddPin,
  {
    channel_id: "C082T4F6S1N",
    message: "1645554142.024680",
  },
);