ConvertKit(獨立出版商)
ConvertKit 是創作者 go-to 營銷中心,可幫助您輕鬆擴大受眾並從中獲利。 使用漂亮的登陸頁面和選擇加入模板將您的關注者從社交媒體、YouTube 等轉換為您的電子郵件列表。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | 特洛伊·泰勒 |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | Troy Taylor,日立解決方案 |
| 網站 | https://convertkit.com/ |
| 隱私策略 | https://convertkit.com/privacy |
| 類別 | Marketing |
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| API 密碼 | securestring | 此 API 的 API 密碼 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 列出序列 |
擷取帳戶的序列清單。 |
| 列出序列的訂閱 |
擷取包含訂閱者資料的序列訂閱。 |
| 列出廣播 |
擷取您帳戶所有廣播的清單。 |
| 列出標籤的訂閱 |
擷取標籤的訂閱清單,包括訂閱者資料。 |
| 列出表單的訂閱 |
擷取包含訂閱者資料的表單訂閱清單。 |
| 列出訂閱者 |
傳回訂閱者的清單。 僅針對取消訂閱,請使用排序欄位參數的取消時間值(目前唯一支援的額外排序欄位)。 |
| 列出訂閱者的標籤 |
擷取訂閱者所有標籤的清單。 |
| 列出購買項目 |
擷取帳戶所有購買的清單。 |
| 取得帳戶 |
擷取目前的帳戶。 |
| 取得廣播統計資料 |
擷取特定廣播的統計資料(收件者計數、開啟率、點按率、取消訂閱計數、點按總數、狀態和傳送進度)。 |
| 取得表單 |
擷取您帳戶所有表單的清單。 |
| 取得訂閱者 |
擷取單一訂閱者記錄。 |
| 取消訂閱訂閱者 |
取消訂閱所有表單和序列的訂閱者。 |
| 將訂閱者新增至序列 |
訂閱您的其中一個序列的電子郵件地址。 |
| 將訂閱者新增至表單 |
訂閱您的其中一個表單的電子郵件地址。 |
| 建立廣播 |
建立草稿或排定的廣播。 您可以建立沒有任何屬性的草稿廣播。 預定的廣播至少應包含主旨行和您的內容。 |
| 建立標籤 |
建立新標籤。 |
| 建立購買項目 |
建立購買項目。 |
| 從訂閱者中移除標籤 |
從訂閱者移除標籤。 |
| 擷取廣播 |
擷取特定廣播的詳細資料,包括草稿、排程和先前傳送的廣播。 |
| 更新廣播 |
更新特定廣播的屬性。 目前正在傳送或已傳送的廣播可能不會更新。 |
| 更新訂閱者 |
更新單一訂閱者的資訊。 |
| 標記訂閱者 |
標籤會作為訂用帳戶處理。 將電子郵件地址訂閱到標籤,以將該標籤套用至具有該電子郵件地址的訂閱者。 |
| 清單標籤 |
擷取帳戶的標籤清單。 |
| 購買 |
按 ID 檢索特定購買。 |
| 透過電子郵件從訂閱者中移除標籤 |
透過電子郵件地址從訂閱者中移除標籤。 |
| 銷毀廣播 |
永久刪除草稿或排定的廣播記錄。 目前正在傳送或已傳送的廣播可能無法刪除。 |
列出序列
擷取帳戶的序列清單。
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Courses
|
courses | array of object | |
|
ID
|
courses.id | integer |
唯一識別碼。 |
|
名稱
|
courses.name | string |
名稱。 |
|
創建於
|
courses.created_at | string |
建立時。 |
列出序列的訂閱
擷取包含訂閱者資料的序列訂閱。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
順序標識碼
|
sequence_id | True | string |
序列唯一識別碼。 |
|
排序順序
|
sort_order | string |
排序順序。 |
|
|
訂閱者狀態
|
subscriber_state | string |
訂閱者的狀態。 |
|
|
頁面
|
page | integer |
頁面。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
訂閱總數
|
total_subscriptions | integer |
訂閱總數。 |
|
頁面
|
page | integer |
頁面。 |
|
總頁數
|
total_pages | integer |
總頁數。 |
|
訂閱
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
唯一識別碼。 |
|
State
|
subscriptions.state | string |
國家。 |
|
創建於
|
subscriptions.created_at | string |
建立時。 |
|
來源
|
subscriptions.source | string |
來源。 |
|
推薦人
|
subscriptions.referrer | string |
反向連結。 |
|
可訂閱 ID
|
subscriptions.subscribable_id | integer |
可訂閱的唯一識別碼。 |
|
可訂閱類型
|
subscriptions.subscribable_type | string |
可訂閱類型。 |
|
ID
|
subscriptions.subscriber.id | integer |
唯一識別碼。 |
|
名字
|
subscriptions.subscriber.first_name | string |
第一個名字。 |
|
電子郵件地址
|
subscriptions.subscriber.email_address | string |
電子郵件地址。 |
|
State
|
subscriptions.subscriber.state | string |
國家。 |
|
創建於
|
subscriptions.subscriber.created_at | string |
建立時。 |
|
姓氏
|
subscriptions.subscriber.fields.last_name | string |
姓氏。 |
列出廣播
擷取您帳戶所有廣播的清單。
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
廣播
|
broadcasts | array of object | |
|
ID
|
broadcasts.id | integer |
唯一識別碼。 |
|
創建於
|
broadcasts.created_at | string |
建立時。 |
|
主旨
|
broadcasts.subject | string |
主題。 |
列出標籤的訂閱
擷取標籤的訂閱清單,包括訂閱者資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
標籤 ID
|
tag_id | True | string |
標籤唯一識別碼。 |
|
排序順序
|
sort_order | string |
排序順序。 |
|
|
訂閱者狀態
|
subscriber_state | string |
訂閱者的狀態。 |
|
|
頁面
|
page | integer |
頁面。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
訂閱總數
|
total_subscriptions | integer |
訂閱總數。 |
|
頁面
|
page | integer |
頁面。 |
|
總頁數
|
total_pages | integer |
總頁數。 |
|
訂閱
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
唯一識別碼。 |
|
State
|
subscriptions.state | string |
國家。 |
|
創建於
|
subscriptions.created_at | string |
建立時。 |
|
來源
|
subscriptions.source | string |
來源。 |
|
推薦人
|
subscriptions.referrer | string |
反向連結。 |
|
可訂閱 ID
|
subscriptions.subscribable_id | integer |
可訂閱的唯一識別碼。 |
|
可訂閱類型
|
subscriptions.subscribable_type | string |
可訂閱類型。 |
|
ID
|
subscriptions.subscriber.id | integer |
唯一識別碼。 |
|
名字
|
subscriptions.subscriber.first_name | string |
第一個名字。 |
|
電子郵件地址
|
subscriptions.subscriber.email_address | string |
電子郵件地址。 |
|
State
|
subscriptions.subscriber.state | string |
國家。 |
|
創建於
|
subscriptions.subscriber.created_at | string |
建立時。 |
|
姓氏
|
subscriptions.subscriber.fields.last_name | string |
姓氏。 |
列出表單的訂閱
擷取包含訂閱者資料的表單訂閱清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表單 ID
|
form_id | True | string |
表單唯一識別碼。 |
|
排序順序
|
sort_order | string |
排序順序。 |
|
|
訂閱者狀態
|
subscriber_state | string |
訂閱者的狀態。 |
|
|
頁面
|
page | integer |
頁面。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
訂閱總數
|
total_subscriptions | integer |
訂閱總數。 |
|
頁面
|
page | integer |
頁面。 |
|
總頁數
|
total_pages | integer |
總頁數。 |
|
訂閱
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
唯一識別碼。 |
|
State
|
subscriptions.state | string |
國家。 |
|
創建於
|
subscriptions.created_at | string |
建立時。 |
|
來源
|
subscriptions.source | string |
來源。 |
|
推薦人
|
subscriptions.referrer | string |
反向連結。 |
|
可訂閱 ID
|
subscriptions.subscribable_id | integer |
可訂閱的唯一識別碼。 |
|
可訂閱類型
|
subscriptions.subscribable_type | string |
可訂閱類型。 |
|
ID
|
subscriptions.subscriber.id | integer |
唯一識別碼。 |
|
名字
|
subscriptions.subscriber.first_name | string |
第一個名字。 |
|
電子郵件地址
|
subscriptions.subscriber.email_address | string |
電子郵件地址。 |
|
State
|
subscriptions.subscriber.state | string |
國家。 |
|
創建於
|
subscriptions.subscriber.created_at | string |
建立時。 |
|
姓氏
|
subscriptions.subscriber.fields.last_name | string |
姓氏。 |
列出訂閱者
傳回訂閱者的清單。 僅針對取消訂閱,請使用排序欄位參數的取消時間值(目前唯一支援的額外排序欄位)。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
寄件者
|
from | string |
從。 |
|
|
發往
|
to | string |
到。 |
|
|
更新自
|
updated_from | string |
更新時。 |
|
|
更新為
|
updated_to | string |
更新到時。 |
|
|
排序順序
|
sort_order | string |
排序順序。 |
|
|
排序欄位
|
sort_field | string |
排序欄位。 |
|
|
電子郵件地址
|
email_address | string |
電子郵件地址。 |
|
|
頁面
|
page | integer |
頁面。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
訂閱者總數
|
total_subscribers | integer |
訂閱者總數。 |
|
頁面
|
page | integer |
頁面。 |
|
總頁數
|
total_pages | integer |
總頁數。 |
|
Subscribers
|
subscribers | array of object | |
|
ID
|
subscribers.id | integer |
唯一識別碼。 |
|
名字
|
subscribers.first_name | string |
第一個名字。 |
|
電子郵件地址
|
subscribers.email_address | string |
電子郵件地址。 |
|
State
|
subscribers.state | string |
國家。 |
|
創建於
|
subscribers.created_at | string |
建立時。 |
|
姓氏
|
subscribers.fields.last_name | string |
姓氏。 |
列出訂閱者的標籤
擷取訂閱者所有標籤的清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
訂閱者 ID
|
subscriber_id | True | string |
訂閱者唯一識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Tags
|
tags | array of object | |
|
ID
|
tags.id | integer |
唯一識別碼。 |
|
名稱
|
tags.name | string |
名稱。 |
|
創建於
|
tags.created_at | string |
建立時。 |
列出購買項目
擷取帳戶所有購買的清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
頁面
|
page | integer |
頁面。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
總購買量
|
total_purchases | integer |
總購買量。 |
|
頁面
|
page | integer |
頁面。 |
|
總頁數
|
total_pages | integer |
總頁數。 |
|
購買
|
purchases | array of object | |
|
ID
|
purchases.id | integer |
唯一識別碼。 |
|
交易 ID
|
purchases.transaction_id | string |
交易唯一識別碼。 |
|
地位
|
purchases.status | string |
狀態。 |
|
電子郵件地址
|
purchases.email_address | string |
電子郵件地址。 |
|
貨幣
|
purchases.currency | string |
貨幣。 |
|
交易時間
|
purchases.transaction_time | string |
交易時間。 |
|
小計
|
purchases.subtotal | integer |
小計。 |
|
航運
|
purchases.shipping | integer |
運輸。 |
|
Discount
|
purchases.discount | integer |
折扣。 |
|
稅額
|
purchases.tax | integer |
稅收。 |
|
總數
|
purchases.total | integer |
總計。 |
|
Products
|
purchases.products | array of object | |
|
單價
|
purchases.products.unit_price | integer |
單價。 |
|
數量
|
purchases.products.quantity | integer |
數量。 |
|
SKU
|
purchases.products.sku | string |
SKU。 |
|
名稱
|
purchases.products.name | string |
名稱。 |
取得帳戶
擷取目前的帳戶。
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
名稱。 |
|
計劃類型
|
plan_type | string |
計劃類型。 |
|
主要電子郵件地址
|
primary_email_address | string |
主要電子郵件地址。 |
取得廣播統計資料
擷取特定廣播的統計資料(收件者計數、開啟率、點按率、取消訂閱計數、點按總數、狀態和傳送進度)。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
廣播 ID
|
broadcast_id | True | string |
廣播唯一識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
廣播
|
broadcast | array of object | |
|
ID
|
broadcast.id | integer |
唯一識別碼。 |
|
收件者
|
broadcast.stats.recipients | integer |
收件人。 |
|
開啟率
|
broadcast.stats.open_rate | float |
打開率。 |
|
點擊「費率」
|
broadcast.stats.click_rate | float |
點擊率。 |
|
取消訂閱
|
broadcast.stats.unsubscribes | integer |
取消訂閱。 |
|
點擊總數
|
broadcast.stats.total_clicks | integer |
點擊總數。 |
|
顯示點擊總數
|
broadcast.stats.show_total_clicks | boolean |
是否顯示總點擊次數。 |
|
地位
|
broadcast.stats.status | string |
狀態。 |
|
Progress
|
broadcast.stats.progress | integer |
進步。 |
取得表單
擷取您帳戶所有表單的清單。
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
表單
|
forms | array of object | |
|
ID
|
forms.id | integer |
唯一識別碼。 |
|
名稱
|
forms.name | string |
名稱。 |
|
創建於
|
forms.created_at | string |
建立時。 |
|
類型
|
forms.type | string |
型別。 |
|
格式
|
forms.format | string |
格式。 |
|
URL
|
forms.url | string |
URL 位址。 |
|
嵌入 JS
|
forms.embed_js | string |
要嵌入的 Javascript。 |
|
內嵌網址
|
forms.embed_url | string |
要內嵌的 URL 位址。 |
|
Title
|
forms.title | string |
標題。 |
|
Description
|
forms.description | string |
描述。 |
|
註冊按鈕文字
|
forms.sign_up_button_text | string |
註冊按鈕文字。 |
|
成功訊息
|
forms.success_message | string |
成功訊息。 |
|
Archived
|
forms.archived | boolean |
是否存檔。 |
|
UID
|
forms.uid | string |
唯一識別碼。 |
取得訂閱者
擷取單一訂閱者記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
訂閱者 ID
|
subscriber_id | True | string |
訂閱者唯一識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
唯一識別碼。 |
|
名字
|
subscriber.first_name | string |
第一個名字。 |
|
電子郵件地址
|
subscriber.email_address | string |
電子郵件地址。 |
|
State
|
subscriber.state | string |
國家。 |
|
創建於
|
subscriber.created_at | string |
建立時。 |
|
姓氏
|
subscriber.fields.last_name | string |
姓氏。 |
取消訂閱訂閱者
取消訂閱所有表單和序列的訂閱者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Email
|
True | string |
電子郵件地址。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
唯一識別碼。 |
|
名字
|
subscriber.first_name | string |
第一個名字。 |
|
電子郵件地址
|
subscriber.email_address | string |
電子郵件地址。 |
|
State
|
subscriber.state | string |
國家。 |
|
創建於
|
subscriber.created_at | string |
建立時。 |
|
姓氏
|
subscriber.fields.last_name | string |
姓氏。 |
將訂閱者新增至序列
訂閱您的其中一個序列的電子郵件地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
順序標識碼
|
sequence_id | True | string |
序列唯一識別碼。 |
|
Email
|
True | string |
電子郵件地址。 |
|
|
名字
|
first_name | string |
第一個名字。 |
|
|
Tags
|
tags | array of integer |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
subscription.id | integer |
唯一識別碼。 |
|
State
|
subscription.state | string |
國家。 |
|
創建於
|
subscription.created_at | string |
建立時。 |
|
來源
|
subscription.source | string |
來源。 |
|
推薦人
|
subscription.referrer | string |
反向連結。 |
|
可訂閱 ID
|
subscription.subscribable_id | integer |
可訂閱的唯一識別碼。 |
|
可訂閱類型
|
subscription.subscribable_type | string |
可訂閱類型。 |
|
ID
|
subscription.subscriber.id | integer |
唯一識別碼。 |
將訂閱者新增至表單
訂閱您的其中一個表單的電子郵件地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表單 ID
|
form_id | True | string |
表單唯一識別碼。 |
|
Email
|
True | string |
電子郵件地址。 |
|
|
名字
|
first_name | string |
第一個名字。 |
|
|
Tags
|
tags | array of integer |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
subscription.id | integer |
唯一識別碼。 |
|
State
|
subscription.state | string |
國家。 |
|
創建於
|
subscription.created_at | string |
建立時。 |
|
來源
|
subscription.source | string |
來源。 |
|
推薦人
|
subscription.referrer | string |
反向連結。 |
|
可訂閱 ID
|
subscription.subscribable_id | integer |
可訂閱的唯一識別碼。 |
|
可訂閱類型
|
subscription.subscribable_type | string |
可訂閱類型。 |
|
ID
|
subscription.subscriber.id | integer |
唯一識別碼。 |
|
名字
|
subscription.subscriber.first_name | string |
第一個名字。 |
|
電子郵件地址
|
subscription.subscriber.email_address | string |
電子郵件地址。 |
|
State
|
subscription.subscriber.state | string |
國家。 |
|
創建於
|
subscription.subscriber.created_at | string |
建立時。 |
建立廣播
建立草稿或排定的廣播。 您可以建立沒有任何屬性的草稿廣播。 預定的廣播至少應包含主旨行和您的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Description
|
description | string |
描述。 |
|
|
主旨
|
subject | string |
主題。 |
|
|
Content
|
content | string |
內容。 |
|
|
電子郵件地址
|
email_address | string |
電子郵件地址。 |
|
|
電子郵件版面配置範本
|
email_layout_template | string |
電子郵件版面配置範本。 |
|
|
公開
|
public | boolean |
是否公開。 |
|
|
發表於
|
published_at | string |
發佈於。 |
|
|
發送至
|
send_at | string |
發送時。 |
|
|
縮略圖 Alt
|
thumbnail_alt | string |
縮圖的替代文字。 |
|
|
縮圖網址
|
thumbnail_url | string |
縮圖的 URL 位址。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
唯一識別碼。 |
|
創建於
|
broadcast.created_at | string |
建立時。 |
|
主旨
|
broadcast.subject | string |
主題。 |
|
Description
|
broadcast.description | string |
描述。 |
|
Content
|
broadcast.content | string |
內容。 |
|
公開
|
broadcast.public | boolean |
是否公開。 |
|
發表於
|
broadcast.published_at | string |
發佈於。 |
|
發送至
|
broadcast.send_at | string |
當發送到。 |
|
縮略圖 Alt
|
broadcast.thumbnail_alt | string |
縮圖的替代文字。 |
|
縮圖網址
|
broadcast.thumbnail_url | string |
縮圖的 URL 位址。 |
|
電子郵件地址
|
broadcast.email_address | string |
電子郵件地址。 |
|
電子郵件版面配置範本
|
broadcast.email_layout_template | string |
電子郵件版面配置範本。 |
建立標籤
建立新標籤。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
name | True | string |
名稱。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
帳戶識別碼
|
account_id | integer |
帳戶唯一識別碼。 |
|
創建於
|
created_at | string |
建立時。 |
|
刪除時間
|
deleted_at | string |
刪除時。 |
|
ID
|
id | integer |
唯一識別碼。 |
|
名稱
|
name | string |
名稱。 |
|
State
|
state | string |
國家。 |
|
更新於
|
updated_at | string |
更新時。 |
建立購買項目
建立購買項目。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
交易 ID
|
transaction_id | True | string |
交易唯一識別碼。 |
|
電子郵件地址
|
email_address | True | string |
電子郵件地址。 |
|
名字
|
first_name | string |
第一個名字。 |
|
|
貨幣
|
currency | True | string |
貨幣。 |
|
交易時間
|
transaction_time | string |
交易時間。 |
|
|
小計
|
subtotal | integer |
小計。 |
|
|
稅額
|
tax | integer |
稅收。 |
|
|
航運
|
shipping | integer |
運輸。 |
|
|
Discount
|
discount | integer |
折扣。 |
|
|
總數
|
total | integer |
總計。 |
|
|
地位
|
status | string |
狀態。 |
|
|
PID
|
pid | True | integer |
個人識別碼。 |
|
蓋
|
lid | True | integer |
蓋子。 |
|
名稱
|
name | True | string |
名稱。 |
|
SKU
|
sku | string |
SKU。 |
|
|
單價
|
unit_price | True | integer |
單價。 |
|
數量
|
quantity | True | integer |
數量。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
唯一識別碼。 |
|
交易 ID
|
transaction_id | string |
交易唯一識別碼。 |
|
地位
|
status | string |
狀態。 |
|
電子郵件地址
|
email_address | string |
電子郵件地址。 |
|
貨幣
|
currency | string |
貨幣。 |
|
交易時間
|
transaction_time | string |
交易時間。 |
|
小計
|
subtotal | integer |
小計。 |
|
Discount
|
discount | integer |
折扣。 |
|
稅額
|
tax | integer |
稅收。 |
|
航運
|
shipping | integer |
運輸。 |
|
總數
|
total | integer |
總計。 |
|
Products
|
products | array of object | |
|
單價
|
products.unit_price | integer |
單價。 |
|
數量
|
products.quantity | integer |
數量。 |
|
SKU
|
products.sku | string |
SKU。 |
|
名稱
|
products.name | string |
名稱。 |
從訂閱者中移除標籤
從訂閱者移除標籤。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
訂閱者 ID
|
subscriber_id | True | string |
訂閱者唯一識別碼。 |
|
標籤 ID
|
tag_id | True | string |
標籤唯一識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
唯一識別碼。 |
|
名稱
|
name | string |
名稱。 |
|
創建於
|
created_at | string |
建立時。 |
擷取廣播
擷取特定廣播的詳細資料,包括草稿、排程和先前傳送的廣播。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
廣播 ID
|
broadcast_id | True | string |
廣播唯一識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
唯一識別碼。 |
|
創建於
|
broadcast.created_at | string |
建立時。 |
|
主旨
|
broadcast.subject | string |
主題。 |
|
Description
|
broadcast.description | string |
描述。 |
|
Content
|
broadcast.content | string |
內容。 |
|
公開
|
broadcast.public | boolean |
是否公開。 |
|
發表於
|
broadcast.published_at | string |
發佈於。 |
|
發送至
|
broadcast.send_at | string |
當發送到。 |
|
縮略圖 Alt
|
broadcast.thumbnail_alt | string |
縮圖的替代文字。 |
|
縮圖網址
|
broadcast.thumbnail_url | string |
縮圖的 URL 位址。 |
|
電子郵件地址
|
broadcast.email_address | string |
電子郵件地址。 |
|
電子郵件版面配置範本
|
broadcast.email_layout_template | string |
電子郵件版面配置範本。 |
更新廣播
更新特定廣播的屬性。 目前正在傳送或已傳送的廣播可能不會更新。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
廣播 ID
|
broadcast_id | True | string |
廣播唯一識別碼。 |
|
Description
|
description | string |
描述。 |
|
|
主旨
|
subject | string |
主題。 |
|
|
Content
|
content | string |
內容。 |
|
|
電子郵件地址
|
email_address | string |
電子郵件地址。 |
|
|
電子郵件版面配置範本
|
email_layout_template | string |
電子郵件版面配置範本。 |
|
|
公開
|
public | boolean |
是否公開。 |
|
|
發表於
|
published_at | string |
發佈於。 |
|
|
發送至
|
send_at | string |
發送時。 |
|
|
縮略圖 Alt
|
thumbnail_alt | string |
縮圖的替代文字。 |
|
|
縮圖網址
|
thumbnail_url | string |
縮圖的 URL 位址。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
唯一識別碼。 |
|
創建於
|
broadcast.created_at | string |
建立時。 |
|
主旨
|
broadcast.subject | string |
主題。 |
|
Description
|
broadcast.description | string |
描述。 |
|
Content
|
broadcast.content | string |
內容。 |
|
公開
|
broadcast.public | boolean |
是否公開。 |
|
發表於
|
broadcast.published_at | string |
發佈於。 |
|
發送至
|
broadcast.send_at | string |
當發送到。 |
|
縮略圖 Alt
|
broadcast.thumbnail_alt | string |
縮圖的替代文字。 |
|
縮圖網址
|
broadcast.thumbnail_url | string |
縮圖的 URL 位址。 |
|
電子郵件地址
|
broadcast.email_address | string |
電子郵件地址。 |
|
電子郵件版面配置範本
|
broadcast.email_layout_template | string |
電子郵件版面配置範本。 |
更新訂閱者
更新單一訂閱者的資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
訂閱者 ID
|
subscriber_id | True | string |
訂閱者唯一識別碼。 |
|
名字
|
first_name | string |
第一個名字。 |
|
|
電子郵件地址
|
email_address | string |
電子郵件地址。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
唯一識別碼。 |
|
名字
|
subscriber.first_name | string |
第一個名字。 |
|
電子郵件地址
|
subscriber.email_address | string |
電子郵件地址。 |
|
State
|
subscriber.state | string |
國家。 |
|
創建於
|
subscriber.created_at | string |
建立時。 |
標記訂閱者
標籤會作為訂用帳戶處理。 將電子郵件地址訂閱到標籤,以將該標籤套用至具有該電子郵件地址的訂閱者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
標籤 ID
|
tag_id | True | string |
標籤唯一識別碼。 |
|
Email
|
string |
電子郵件地址。 |
||
|
名字
|
first_name | string |
第一個名字。 |
|
|
Tags
|
tags | array of integer |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
subscription.id | integer |
唯一識別碼。 |
|
State
|
subscription.state | string |
國家。 |
|
創建於
|
subscription.created_at | string |
建立時。 |
|
來源
|
subscription.source | string |
來源。 |
|
推薦人
|
subscription.referrer | string |
反向連結。 |
|
可訂閱 ID
|
subscription.subscribable_id | integer |
可訂閱的唯一識別碼。 |
|
可訂閱類型
|
subscription.subscribable_type | string |
可訂閱類型。 |
|
ID
|
subscription.subscriber.id | integer |
唯一識別碼。 |
清單標籤
擷取帳戶的標籤清單。
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Tags
|
tags | array of object | |
|
ID
|
tags.id | integer |
唯一識別碼。 |
|
名稱
|
tags.name | string |
名稱。 |
|
創建於
|
tags.created_at | string |
建立時。 |
購買
按 ID 檢索特定購買。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
購買 ID
|
purchase_id | True | string |
購買識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
唯一識別碼。 |
|
交易 ID
|
transaction_id | string |
交易唯一識別碼。 |
|
地位
|
status | string |
狀態。 |
|
電子郵件地址
|
email_address | string |
電子郵件地址。 |
|
貨幣
|
currency | string |
貨幣。 |
|
交易時間
|
transaction_time | string |
交易時間。 |
|
小計
|
subtotal | integer |
小計。 |
|
航運
|
shipping | integer |
運輸。 |
|
Discount
|
discount | integer |
折扣。 |
|
稅額
|
tax | integer |
稅收。 |
|
總數
|
total | integer |
總計。 |
|
Products
|
products | array of object | |
|
單價
|
products.unit_price | integer |
單價。 |
|
數量
|
products.quantity | integer |
數量。 |
|
SKU
|
products.sku | string |
SKU。 |
|
名稱
|
products.name | string |
名稱。 |
透過電子郵件從訂閱者中移除標籤
透過電子郵件地址從訂閱者中移除標籤。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
標籤 ID
|
tag_id | True | string |
標籤唯一識別碼。 |
|
Email
|
True | string |
電子郵件地址。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
唯一識別碼。 |
|
名稱
|
name | string |
名稱。 |
|
創建於
|
created_at | string |
建立時。 |
銷毀廣播
永久刪除草稿或排定的廣播記錄。 目前正在傳送或已傳送的廣播可能無法刪除。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
廣播 ID
|
broadcast_id | True | string |
廣播唯一識別碼。 |
傳回
- response
- string
定義
字串
這是基本資料類型「string」。