canvas_copy

Facts

DescriptionCopy a canvas

SchemaSchema.slack.functions.CanvasCopy

Schema referenceslack#/functions/canvas_copy

Required scopes

canvases:readcanvases:write

Input Parameters

Required Input Parameters

canvas_idSchema.slack.types.canvas_idRequired

Select a canvas

owner_idSchema.slack.types.user_idRequired

Canvas owner id

titleSchema.types.stringRequired

Canvas name

Optional Input Parameters

placeholder_valuesSchema.types.objectOptional

A dictionary of key-value pairs representing canvas variables.

Output Parameters

Required Output Parameters

canvas_idSchema.slack.types.canvas_idRequired

Canvas link

Usage info

This function copies a canvas. The app using this function will need the following App Home features set in the app manifest file:

features: {
  appHome: {
    messagesTabEnabled: true,
    messagesTabReadOnlyEnabled: false,
  },
},

For information about the expanded_rich_text type that you can use to update your canvases, refer to expanded_rich_text.

Example workflow step

const copyCanvasStep = ExampleWorkflow.addStep(
  Schema.slack.functions.CanvasCopy,
  {
    canvas_id: "CAN87654",
    title: "My new canvas",
    owner_id: "ABC123456"
  },
);