Skip to content

APIを使用したCanvasの複製

post

/canvas/duplicate

core endpoint

このエンドポイントを使用して、Canvasを複製します。このAPIエンドポイントは、BrazeダッシュボードでのCanvasの複製に似ています。

前提条件

このエンドポイントを使用するには、canvas.duplicate 権限を持つAPIキーを生成する必要があります。

レート制限

このエンドポイントは、1分あたり100回のAPIコールに制限されます。

リクエスト本文

1
2

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
5
6

{
  "canvas_id": (required, string) The Canvas identifier,
  "name": (required, string) The name of the resulting Canvas,
  "description": (optional, string) The description of the resulting Canvas,
  "tag_names": (optional, string) The tags of the resulting Canvas,
}

リクエストパラメーター

パラメーター 必須 データタイプ 説明
canvas_id 必須 文字列 Canvas識別子を参照してください。
name 必須 文字列 作成されるCanvasの名前。
description オプション 文字列 作成されるCanvasの説明フィールド。
tag_names オプション 文字列 作成されるCanvasのタグ。これらは既存のタグである必要があります。リクエストに新しいタグを追加すると、元のCanvasにあったすべてのタグが上書きされます。

応答

このエンドポイントは 202 ステータスコードを返し、Canvasの作成は非同期で行われます。セキュリティイベントのダウンロードを使用すると、Canvasがいつ複製され、どのAPIキーによって行われたかの記録を確認できます。
New Stuff!