Skip to main content

archive_channel

Facts​

DescriptionArchive a channel
SchemaSchema.slack.functions.ArchiveChannel
Schema referenceslack#/functions/archive_channel
Required scopes
channels:writeim:writegroups:writempim:write

Input Parameters​

Required Input Parameters

channel_idSchema.slack.types.channel_idRequired

The conversation ID for the channel you are archiving

Examples
C123456
D123ABC456

Output Parameters​

Required Output Parameters

channel_idSchema.slack.types.channel_idRequired

The conversation ID for the channel you archived

Examples
C123456
D123ABC456

Usage info​

Not all conversations need to continue forever, so when the project is done, this function archives the channel, preventing new messages from being posted while preserving its history.

Example workflow step​

const archiveChannelStep = ExampleWorkflow.addStep(
  Schema.slack.functions.ArchiveChannel,
  {
    channel_id: "C0123ABC456",
  },
);