メインコンテンツへスキップ
POST
/
channels
/
templates
チャネルテンプレート一覧
curl --request POST \
  --url https://api.pubrio.com/channels/templates \
  --header 'Content-Type: application/json' \
  --header 'pubrio-api-key: <api-key>' \
  --data '
{
  "channel_template_name": "channel template",
  "channel_nodes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "channel_types": [
    1,
    2
  ],
  "per_page": 25,
  "page": 1,
  "profile_id": 123
}
'
{
  "data": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_entries": 4,
      "total_pages": 1,
      "is_timeout": false
    },
    "channel_templates": [
      {
        "channel_template_id": 1,
        "channel_template_identifier": "4f6f40cb-ed6d-4cca-99d8-616feef8de93",
        "channel_node_id": "93873c33-2635-4537-928c-6a4f3564164c",
        "channel_node_slug": "send_email",
        "channel_type_id": 1,
        "channel_type_slug": "email",
        "owner_email": "[email protected]",
        "owner_name": "Owner",
        "name": "email",
        "version_number": 1,
        "version_name": "version 1",
        "is_default": true,
        "is_personal": true,
        "created_at": "2025-07-29T09:07:11.969Z",
        "last_modified": "2025-07-29T09:07:11.969Z",
        "channel_template_versions": [
          {
            "channel_template_id": 1,
            "channel_template_identifier": "4f6f40cb-ed6d-4cca-99d8-616feef8de93",
            "channel_node_id": "93873c33-2635-4537-928c-6a4f3564164c",
            "channel_node_slug": "send_email",
            "channel_type_id": 1,
            "channel_type_slug": "email",
            "owner_email": "[email protected]",
            "owner_name": "Owner",
            "name": "email",
            "parameters": {
              "content": "<div>hello world</div>",
              "subject": "Hello World",
              "attachments": []
            },
            "version_number": 1,
            "version_name": "version 1",
            "default_values": null,
            "is_default": true,
            "is_personal": true,
            "created_at": "2025-07-29T09:07:11.969581",
            "last_modified": "2025-07-29T09:07:11.969581"
          }
        ]
      },
      "..."
    ]
  }
}

承認

​
pubrio-api-key
string
header
必須

API で実行する操作内容と、その操作に付与された権限を識別するための一意の API トークンです。このトークンはダッシュボードの 設定 画面から発行できます。

ボディ

application/json
​
channel_template_name
string

指定したチャネルテンプレート名のみが含まれるように検索結果を絞り込みます。

例:

"channel template"

​
channel_nodes
string<uuid>[]

特定のチャネルノードを検索するために使用する channel_node_id の一覧です。

​
channel_types
integer[]

特定のチャネル種別を検索するために使用する channel_type_id の一覧です。

例:
[1, 2]
​
per_page
integer

1 ページあたりに返される検索結果件数です。ページサイズを制限することで、レスポンス速度や API パフォーマンスの向上が期待できます。

例:

25

​
page
integer

取得したい結果セットのページ番号です。

例:

1

​
profile_id
integer

オプション。リクエストを送信するチームを表す識別子です。API キーにワークスペース情報が既に含まれているため、このパラメータは必須ではなくなりました。指定した場合、検索結果が特定のチーム（ワークスペース）に紐づけられ、データ取得およびクレジット利用状況の追跡が可能になります。詳しくは、チーム関連の「ユーザー詳細」エンドポイントを参照してください。

レスポンス

関連する詳細情報を含む成功レスポンスです。

​
data
object

エンドポイント固有のレスポンスをオブジェクト形式で格納する汎用コンテナです。