Moosend (獨立發行者) (預覽版)
終極電子郵件行銷軟體和行銷自動化平台,不會讓您傾家蕩產。 有數百個 up-to日期模板可供選擇,您的電子郵件營銷活動將為成功做好準備。
此連接器適用於以下產品和區域:
| 服務 | 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 | 特洛伊·泰勒 |
| 網站 | https://moosend.com/ |
| 隱私策略 | https://www.sitecore.com/trust/privacy-policy |
| 類別 | Marketing |
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| API 金鑰 | securestring | 此 API 的 API 金鑰 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 依位置取得活動 |
依國家/地區傳回行銷活動開啟次數 (不重複和總計) 的詳細報告。 |
| 傳送行銷活動 |
將現有的草稿行銷活動傳送給其郵件清單中指定的所有收件者。 活動會立即傳送。 |
| 刪除行銷活動 |
從您的帳戶、草稿甚至發送中刪除活動。 |
| 刪除郵件清單 |
從您的帳戶中刪除郵件清單。 |
| 取得 AB 測試活動摘要 |
針對每個版本(A和B)分別提供已傳送AB測試行銷活動結果的基本摘要,例如迄今為止的收件者數量、開啟次數、點按次數、退信次數、取消訂閱次數、轉寄次數等。 |
| 取得寄件者 |
擷取您帳戶中作用中寄件者的清單。 |
| 取得寄件者詳細資料 |
傳回由其電子郵件地址識別之指定寄件者的資訊。 |
| 取得所有活躍的郵件清單 |
擷取您帳戶中作用中的郵件清單清單。 |
| 取得行銷活動 |
傳回您帳戶中所有行銷活動的清單,其中包含詳細資訊。 |
| 取得行銷活動摘要 |
擷取任何已傳送行銷活動結果的基本摘要,例如迄今為止的收件者數量、開啟次數、點按次數、退信次數、取消訂閱次數、轉寄次數等。 |
| 取得行銷活動統計資料 |
根據傳送、開啟、退信、點按連結等活動等活動擷取指定行銷活動的詳細統計資料清單。 |
| 取得行銷活動詳細資料 |
傳回一組完整的屬性,詳細描述所要求的行銷活動。 |
| 取得連結活動 |
傳回包含行銷活動連結的清單,以及收件者點按的次數(不重複或總數)。 |
| 取得郵件清單詳細資料 |
擷取指定郵件清單的詳細資料。 |
| 取消排程行銷活動 |
從行銷活動中移除先前定義的排程日期和時間,以便在已排入佇列或傳送時立即傳遞。 |
| 取消訂閱帳戶的訂閱者 |
從帳戶取消訂閱訂閱者。 |
| 建立自定義欄位 |
在指定的郵件清單中建立新的自訂欄位。 |
| 建立草稿廣告活動 |
在您的帳戶中建立新的草稿行銷活動。 |
| 建立郵件清單 |
在您的帳戶中建立新的空白郵件清單。 |
| 從郵件列表中取消訂閱 |
從指定的郵件清單中取消訂閱訂閱者。 |
| 排定廣告活動 |
指派行銷活動的排程日期和時間。 |
| 新增多個訂閱者 |
通過一次呼叫在郵件列表中添加多個訂閱者。 |
| 新增訂閱者 |
將新訂閱者新增至指定的郵件清單。 |
| 更新廣告活動草稿 |
更新您帳戶中現有草稿 AB 廣告活動的屬性。 非草稿行銷活動無法更新。 忽略 (AB 分割行銷活動選項) 如果您想要建立一般行銷活動。 |
| 更新自訂欄位 |
更新指定郵件清單中現有自訂欄位的屬性。 |
| 更新訂閱者 |
更新指定郵件清單中的訂閱者。 |
| 更新郵件清單 |
更新現有郵件清單的屬性。 |
| 測試行銷活動 |
將草稿行銷活動的測試電子郵件傳送至您指定要預覽的電子郵件地址清單。 |
| 獲得訂閱者 |
擷取指定郵件清單中所有訂閱者的清單。 |
| 移除多個訂閱者 |
從指定的郵件清單中永久移除訂閱者清單。 |
| 移除自訂欄位 |
從指定的郵件清單中移除自訂欄位定義。 |
| 移除訂閱者 |
從指定的郵件清單中永久移除訂閱者。 |
| 複製現有行銷活動 |
建立現有行銷活動的精確副本。 新行銷活動會建立為草稿。 |
| 通過 ID 獲取訂閱者 |
在指定的郵件清單中搜尋具有指定唯一識別碼的訂閱者。 |
| 通過電子郵件地址獲取訂閱者 |
在指定的郵件清單中搜尋具有指定電子郵件地址的訂閱者。 |
依位置取得活動
依國家/地區傳回行銷活動開啟次數 (不重複和總計) 的詳細報告。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
CampaignId | True | string |
行銷活動識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
頁面大小
|
Context.Paging.PageSize | integer |
頁面大小。 |
|
當前頁面
|
Context.Paging.CurrentPage | integer |
目前頁面。 |
|
總結果
|
Context.Paging.TotalResults | integer |
總結果。 |
|
總頁數
|
Context.Paging.TotalPageCount | integer |
總頁數。 |
|
排序運算式
|
Context.Paging.SortExpression | string |
排序運算式。 |
|
排序是遞增的
|
Context.Paging.SortIsAscending | boolean |
排序是否遞增。 |
|
Analytics
|
Context.Analytics | array of object | |
|
上下文
|
Context.Analytics.Context | string |
上下文。 |
|
內容名稱
|
Context.Analytics.ContextName | string |
環境定義名稱。 |
|
總計數
|
Context.Analytics.TotalCount | integer |
總計數。 |
|
唯一計數
|
Context.Analytics.UniqueCount | integer |
唯一計數。 |
|
上下文描述
|
Context.Analytics.ContextDescription | string |
內容描述。 |
傳送行銷活動
將現有的草稿行銷活動傳送給其郵件清單中指定的所有收件者。 活動會立即傳送。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
CampaignId | True | string |
行銷活動識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
刪除行銷活動
從您的帳戶、草稿甚至發送中刪除活動。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
CampaignId | True | string |
行銷活動識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
刪除郵件清單
從您的帳戶中刪除郵件清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
取得 AB 測試活動摘要
針對每個版本(A和B)分別提供已傳送AB測試行銷活動結果的基本摘要,例如迄今為止的收件者數量、開啟次數、點按次數、退信次數、取消訂閱次數、轉寄次數等。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
CampaignId | True | string |
行銷活動識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
行銷活動ID
|
Context.CampaignID | string |
行銷活動識別碼。 |
|
行銷活動ID
|
Context.A.CampaignID | string |
行銷活動識別碼。 |
|
AB版
|
Context.A.ABVersion | integer |
AB 版本。 |
|
行銷活動名稱
|
Context.A.CampaignName | string |
行銷活動名稱。 |
|
活動主題
|
Context.A.CampaignSubject | string |
活動主題。 |
|
郵件列表
|
Context.A.MailingLists | array of object | |
|
活動
|
Context.A.MailingLists.Campaign | string |
競選活動。 |
|
ID
|
Context.A.MailingLists.MailingList.ID | string |
識別碼。 |
|
名稱
|
Context.A.MailingLists.MailingList.Name | string |
名稱。 |
|
活躍會員數量
|
Context.A.MailingLists.MailingList.ActiveMemberCount | integer |
作用中成員計數。 |
|
退回的會員數量
|
Context.A.MailingLists.MailingList.BouncedMemberCount | integer |
退信的成員計數。 |
|
已移除的成員計數
|
Context.A.MailingLists.MailingList.RemovedMemberCount | integer |
已移除的成員計數。 |
|
未訂閱會員人數
|
Context.A.MailingLists.MailingList.UnsubscribedMemberCount | integer |
取消訂閱的成員計數。 |
|
地位
|
Context.A.MailingLists.MailingList.Status | integer |
狀態。 |
|
自訂欄位定義
|
Context.A.MailingLists.MailingList.CustomFieldsDefinition | array of |
自訂欄位定義。 |
|
作者
|
Context.A.MailingLists.MailingList.CreatedBy | string |
創建者。 |
|
創建日期
|
Context.A.MailingLists.MailingList.CreatedOn | string |
建立時。 |
|
更新者
|
Context.A.MailingLists.MailingList.UpdatedBy | string |
更新者。 |
|
更新於
|
Context.A.MailingLists.MailingList.UpdatedOn | string |
更新了。 |
|
匯入作業
|
Context.A.MailingLists.MailingList.ImportOperation | string |
匯入作業。 |
|
區段
|
Context.A.MailingLists.Segment | string |
該區段。 |
|
活動交付時間
|
Context.A.CampaignDeliveredOn | string |
競選活動繼續進行。 |
|
發往
|
Context.A.To | string |
致地址。 |
|
寄件者
|
Context.A.From | string |
寄件者位址。 |
|
開啟總數
|
Context.A.TotalOpens | integer |
總計打開。 |
|
獨特開啟次數
|
Context.A.UniqueOpens | integer |
獨特的打開。 |
|
總跳出次數
|
Context.A.TotalBounces | integer |
總反彈。 |
|
投訴總數
|
Context.A.TotalComplaints | integer |
投訴總數。 |
|
總遠期
|
Context.A.TotalForwards | integer |
總進發。 |
|
獨特的前鋒
|
Context.A.UniqueForwards | integer |
獨特的前鋒。 |
|
取消訂閱總數
|
Context.A.TotalUnsubscribes | integer |
取消訂閱總數。 |
|
連結點擊總數
|
Context.A.TotalLinkClicks | integer |
連結點擊總數。 |
|
獨特的連結點擊次數
|
Context.A.UniqueLinkClicks | integer |
唯一連結點擊。 |
|
寄件日期
|
Context.A.Sent | integer |
發送的號碼。 |
|
活動已存檔
|
Context.A.CampaignIsArchived | boolean |
行銷活動是否已封存。 |
|
行銷活動ID
|
Context.B.CampaignID | string |
行銷活動識別碼。 |
|
AB版
|
Context.B.ABVersion | integer |
AB 版本。 |
|
行銷活動名稱
|
Context.B.CampaignName | string |
行銷活動名稱。 |
|
活動主題
|
Context.B.CampaignSubject | string |
活動主題。 |
|
郵件列表
|
Context.B.MailingLists | array of object | |
|
活動
|
Context.B.MailingLists.Campaign | string |
競選活動。 |
|
ID
|
Context.B.MailingLists.MailingList.ID | string |
識別碼。 |
|
名稱
|
Context.B.MailingLists.MailingList.Name | string |
名稱。 |
|
活躍會員數量
|
Context.B.MailingLists.MailingList.ActiveMemberCount | integer |
作用中成員計數。 |
|
退回的會員數量
|
Context.B.MailingLists.MailingList.BouncedMemberCount | integer |
退信的成員計數。 |
|
已移除的成員計數
|
Context.B.MailingLists.MailingList.RemovedMemberCount | integer |
已移除的成員計數。 |
|
未訂閱會員人數
|
Context.B.MailingLists.MailingList.UnsubscribedMemberCount | integer |
取消訂閱的成員計數。 |
|
地位
|
Context.B.MailingLists.MailingList.Status | integer |
狀態。 |
|
自訂欄位定義
|
Context.B.MailingLists.MailingList.CustomFieldsDefinition | array of |
自訂欄位定義。 |
|
作者
|
Context.B.MailingLists.MailingList.CreatedBy | string |
創建者。 |
|
創建日期
|
Context.B.MailingLists.MailingList.CreatedOn | string |
建立時。 |
|
更新者
|
Context.B.MailingLists.MailingList.UpdatedBy | string |
更新者。 |
|
更新於
|
Context.B.MailingLists.MailingList.UpdatedOn | string |
更新了。 |
|
匯入作業
|
Context.B.MailingLists.MailingList.ImportOperation | string |
匯入作業。 |
|
區段
|
Context.B.MailingLists.Segment | string |
該區段。 |
|
活動交付時間
|
Context.B.CampaignDeliveredOn | string |
競選活動繼續進行。 |
|
發往
|
Context.B.To | string |
致地址。 |
|
寄件者
|
Context.B.From | string |
寄件者位址。 |
|
開啟總數
|
Context.B.TotalOpens | integer |
總計打開。 |
|
獨特開啟次數
|
Context.B.UniqueOpens | integer |
獨特的打開。 |
|
總跳出次數
|
Context.B.TotalBounces | integer |
總反彈。 |
|
投訴總數
|
Context.B.TotalComplaints | integer |
投訴總數。 |
|
總遠期
|
Context.B.TotalForwards | integer |
總進發。 |
|
獨特的前鋒
|
Context.B.UniqueForwards | integer |
獨特的前鋒。 |
|
取消訂閱總數
|
Context.B.TotalUnsubscribes | integer |
取消訂閱總數。 |
|
連結點擊總數
|
Context.B.TotalLinkClicks | integer |
連結點擊總數。 |
|
獨特的連結點擊次數
|
Context.B.UniqueLinkClicks | integer |
唯一連結點擊。 |
|
寄件日期
|
Context.B.Sent | integer |
發送的號碼。 |
|
活動已存檔
|
Context.B.CampaignIsArchived | boolean |
行銷活動是否已封存。 |
取得寄件者
擷取您帳戶中作用中寄件者的清單。
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | array of object | |
|
ID
|
Context.ID | string |
識別碼。 |
|
名稱
|
Context.Name | string |
名稱。 |
|
Email
|
Context.Email | string |
電子郵件地址。 |
|
創建日期
|
Context.CreatedOn | string |
建立時。 |
|
已啟用
|
Context.IsEnabled | boolean |
是否已啟用。 |
|
SPF 驗證
|
Context.SpfVerified | boolean |
SPF 是否經過驗證。 |
|
DKIM 驗證
|
Context.DkimVerified | boolean |
DKIM 是否經過驗證。 |
|
DKIM 公眾
|
Context.DkimPublic | string |
公共 DKIM。 |
取得寄件者詳細資料
傳回由其電子郵件地址識別之指定寄件者的資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Email
|
True | string |
電子郵件地址。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
ID
|
Context.ID | string |
識別碼。 |
|
名稱
|
Context.Name | string |
名稱。 |
|
Email
|
Context.Email | string |
電子郵件地址。 |
|
創建日期
|
Context.CreatedOn | string |
建立時。 |
|
已啟用
|
Context.IsEnabled | boolean |
是否已啟用。 |
|
SPF 驗證
|
Context.SpfVerified | boolean |
SPF 是否經過驗證。 |
|
DKIM 驗證
|
Context.DkimVerified | boolean |
DKIM 是否經過驗證。 |
|
DKIM 公眾
|
Context.DkimPublic | string |
公共 DKIM。 |
取得所有活躍的郵件清單
擷取您帳戶中作用中的郵件清單清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
頁面
|
Page | True | integer |
頁面。 |
|
頁面大小
|
PageSize | True | integer |
頁面大小。 |
|
排序依據:
|
SortBy | string |
排序方式。 |
|
|
排序方式
|
SortMethod | string |
排序方法。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
頁面大小
|
Context.Paging.PageSize | integer |
頁面大小。 |
|
當前頁面
|
Context.Paging.CurrentPage | integer |
目前頁面。 |
|
總結果
|
Context.Paging.TotalResults | integer |
總結果。 |
|
總頁數
|
Context.Paging.TotalPageCount | integer |
總頁數。 |
|
排序運算式
|
Context.Paging.SortExpression | string |
排序運算式。 |
|
排序是遞增的
|
Context.Paging.SortIsAscending | boolean |
排序是否遞增。 |
|
郵件列表
|
Context.MailingLists | array of object | |
|
ID
|
Context.MailingLists.ID | string |
識別碼。 |
|
名稱
|
Context.MailingLists.Name | string |
名稱。 |
|
活躍會員數量
|
Context.MailingLists.ActiveMemberCount | integer |
作用中成員計數。 |
|
退回的會員數量
|
Context.MailingLists.BouncedMemberCount | integer |
退信的成員計數。 |
|
已移除的成員計數
|
Context.MailingLists.RemovedMemberCount | integer |
已移除的成員計數。 |
|
未訂閱會員人數
|
Context.MailingLists.UnsubscribedMemberCount | integer |
取消訂閱的成員計數。 |
|
地位
|
Context.MailingLists.Status | integer |
狀態。 |
|
自訂欄位定義
|
Context.MailingLists.CustomFieldsDefinition | array of object | |
|
ID
|
Context.MailingLists.CustomFieldsDefinition.ID | string |
識別碼。 |
|
名稱
|
Context.MailingLists.CustomFieldsDefinition.Name | string |
名稱。 |
|
上下文
|
Context.MailingLists.CustomFieldsDefinition.Context | string |
上下文。 |
|
是必要的
|
Context.MailingLists.CustomFieldsDefinition.IsRequired | boolean |
是否需要。 |
|
類型
|
Context.MailingLists.CustomFieldsDefinition.Type | integer |
型別。 |
|
作者
|
Context.MailingLists.CreatedBy | string |
創建者。 |
|
創建日期
|
Context.MailingLists.CreatedOn | string |
建立時。 |
|
更新者
|
Context.MailingLists.UpdatedBy | string |
更新者。 |
|
更新於
|
Context.MailingLists.UpdatedOn | string |
更新了。 |
|
ID
|
Context.MailingLists.ImportOperation.ID | integer |
識別碼。 |
|
資料雜湊
|
Context.MailingLists.ImportOperation.DataHash | string |
資料雜湊。 |
|
映射
|
Context.MailingLists.ImportOperation.Mappings | string |
映射。 |
|
電子郵件通知
|
Context.MailingLists.ImportOperation.EmailNotify | string |
通知電子郵件。 |
|
創建日期
|
Context.MailingLists.ImportOperation.CreatedOn | string |
建立時。 |
|
已啟動
|
Context.MailingLists.ImportOperation.StartedOn | string |
當開始時。 |
|
完成日期
|
Context.MailingLists.ImportOperation.CompletedOn | string |
完成後。 |
|
插入總計
|
Context.MailingLists.ImportOperation.TotalInserted | integer |
插入的總計。 |
|
更新總數
|
Context.MailingLists.ImportOperation.TotalUpdated | integer |
總計更新。 |
|
取消訂閱總數
|
Context.MailingLists.ImportOperation.TotalUnsubscribed | integer |
取消訂閱的總數。 |
|
總無效
|
Context.MailingLists.ImportOperation.TotalInvalid | integer |
總數無效。 |
|
重複總數
|
Context.MailingLists.ImportOperation.TotalDuplicate | integer |
重複總數。 |
|
會員總數
|
Context.MailingLists.ImportOperation.TotalMembers | integer |
成員總數。 |
|
Message
|
Context.MailingLists.ImportOperation.Message | string |
訊息。 |
|
成功
|
Context.MailingLists.ImportOperation.Success | boolean |
是否成功。 |
取得行銷活動
傳回您帳戶中所有行銷活動的清單,其中包含詳細資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
頁面
|
Page | True | string |
頁面。 |
|
頁面大小
|
PageSize | True | string |
頁面大小。 |
|
排序依據:
|
SortBy | string |
排序方式。 |
|
|
排序方式
|
SortMethod | string |
排序方法。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
頁面大小
|
Context.Paging.PageSize | integer |
頁面大小。 |
|
當前頁面
|
Context.Paging.CurrentPage | integer |
目前頁面。 |
|
總結果
|
Context.Paging.TotalResults | integer |
總結果。 |
|
總頁數
|
Context.Paging.TotalPageCount | integer |
總頁數。 |
|
排序運算式
|
Context.Paging.SortExpression | string |
排序運算式。 |
|
排序是遞增的
|
Context.Paging.SortIsAscending | boolean |
排序是否遞增。 |
|
Campaigns
|
Context.Campaigns | array of object | |
|
ID
|
Context.Campaigns.ID | string |
識別碼。 |
|
名稱
|
Context.Campaigns.Name | string |
名稱。 |
|
主旨
|
Context.Campaigns.Subject | string |
主題。 |
|
網站名稱
|
Context.Campaigns.SiteName | string |
網站名稱。 |
|
確認至
|
Context.Campaigns.ConfirmationTo | string |
確認到。 |
|
創建日期
|
Context.Campaigns.CreatedOn | string |
建立時。 |
|
AB 測試時間
|
Context.Campaigns.ABHoursToTest | string |
測試的 AB 小時。 |
|
AB 行銷活動類型
|
Context.Campaigns.ABCampaignType | string |
AB 行銷活動類型。 |
|
A/B 獲勝者
|
Context.Campaigns.ABWinner | string |
AB 獲勝者。 |
|
AB 獲獎者選擇類型
|
Context.Campaigns.ABWinnerSelectionType | string |
AB 獲勝者選擇類型。 |
|
地位
|
Context.Campaigns.Status | integer |
狀態。 |
|
交付日期
|
Context.Campaigns.DeliveredOn | string |
當交付時。 |
|
預定時間
|
Context.Campaigns.ScheduledFor | string |
何時安排。 |
|
排定時區
|
Context.Campaigns.ScheduledForTimezone | string |
排程的時區。 |
|
郵件列表
|
Context.Campaigns.MailingLists | array of object | |
|
活動
|
Context.Campaigns.MailingLists.Campaign | string |
競選活動。 |
|
ID
|
Context.Campaigns.MailingLists.MailingList.ID | string |
識別碼。 |
|
名稱
|
Context.Campaigns.MailingLists.MailingList.Name | string |
名稱。 |
|
活躍會員數量
|
Context.Campaigns.MailingLists.MailingList.ActiveMemberCount | integer |
作用中成員計數。 |
|
退回的會員數量
|
Context.Campaigns.MailingLists.MailingList.BouncedMemberCount | integer |
退信的成員計數。 |
|
已移除的成員計數
|
Context.Campaigns.MailingLists.MailingList.RemovedMemberCount | integer |
已移除的成員計數。 |
|
未訂閱會員人數
|
Context.Campaigns.MailingLists.MailingList.UnsubscribedMemberCount | integer |
取消訂閱的成員計數。 |
|
地位
|
Context.Campaigns.MailingLists.MailingList.Status | integer |
狀態。 |
|
自訂欄位定義
|
Context.Campaigns.MailingLists.MailingList.CustomFieldsDefinition | array of |
自訂欄位定義。 |
|
作者
|
Context.Campaigns.MailingLists.MailingList.CreatedBy | string |
創建者。 |
|
創建日期
|
Context.Campaigns.MailingLists.MailingList.CreatedOn | string |
建立時。 |
|
更新者
|
Context.Campaigns.MailingLists.MailingList.UpdatedBy | string |
更新者。 |
|
更新於
|
Context.Campaigns.MailingLists.MailingList.UpdatedOn | string |
更新時。 |
|
匯入作業
|
Context.Campaigns.MailingLists.MailingList.ImportOperation | string |
匯入作業。 |
|
區段
|
Context.Campaigns.MailingLists.Segment | string |
該區段。 |
|
已發送總數
|
Context.Campaigns.TotalSent | integer |
發送的總計。 |
|
開啟總數
|
Context.Campaigns.TotalOpens | integer |
總計打開。 |
|
獨特開啟次數
|
Context.Campaigns.UniqueOpens | integer |
獨特的打開。 |
|
總跳出次數
|
Context.Campaigns.TotalBounces | integer |
總反彈。 |
|
總遠期
|
Context.Campaigns.TotalForwards | integer |
總進發。 |
|
獨特的前鋒
|
Context.Campaigns.UniqueForwards | integer |
獨特的前鋒。 |
|
連結點擊總數
|
Context.Campaigns.TotalLinkClicks | integer |
連結點擊總數。 |
|
獨特的連結點擊次數
|
Context.Campaigns.UniqueLinkClicks | integer |
唯一連結點擊。 |
|
收件者計數
|
Context.Campaigns.RecipientsCount | integer |
收件人很重要。 |
|
是交易性的
|
Context.Campaigns.IsTransactional | boolean |
是否是交易性的。 |
|
投訴總數
|
Context.Campaigns.TotalComplaints | integer |
投訴總數。 |
|
取消訂閱總數
|
Context.Campaigns.TotalUnsubscribes | integer |
取消訂閱總數。 |
取得行銷活動摘要
擷取任何已傳送行銷活動結果的基本摘要,例如迄今為止的收件者數量、開啟次數、點按次數、退信次數、取消訂閱次數、轉寄次數等。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
CampaignId | True | string |
行銷活動識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
行銷活動ID
|
Context.CampaignID | string |
行銷活動識別碼。 |
|
AB版
|
Context.ABVersion | string |
AB 版本。 |
|
行銷活動名稱
|
Context.CampaignName | string |
行銷活動名稱。 |
|
活動主題
|
Context.CampaignSubject | string |
活動主題。 |
|
郵件列表
|
Context.MailingLists | array of object | |
|
郵件清單 ID
|
Context.MailingLists.MailingListID | string |
郵件清單識別碼。 |
|
區段識別碼
|
Context.MailingLists.SegmentID | integer |
區段識別碼。 |
|
活動交付時間
|
Context.CampaignDeliveredOn | string |
當活動交付時。 |
|
發往
|
Context.To | string |
致地址。 |
|
寄件者
|
Context.From | string |
寄件者位址。 |
|
開啟總數
|
Context.TotalOpens | integer |
總計打開。 |
|
獨特開啟次數
|
Context.UniqueOpens | integer |
獨特的打開。 |
|
總跳出次數
|
Context.TotalBounces | integer |
總反彈。 |
|
投訴總數
|
Context.TotalComplaints | integer |
投訴總數。 |
|
總遠期
|
Context.TotalForwards | integer |
總進發。 |
|
獨特的前鋒
|
Context.UniqueForwards | integer |
獨特的前鋒。 |
|
取消訂閱總數
|
Context.TotalUnsubscribes | integer |
取消訂閱總數。 |
|
連結點擊總數
|
Context.TotalLinkClicks | integer |
連結點擊總數。 |
|
獨特的連結點擊次數
|
Context.UniqueLinkClicks | integer |
唯一連結點擊。 |
|
寄件日期
|
Context.Sent | integer |
發送的號碼。 |
|
活動已存檔
|
Context.CampaignIsArchived | boolean |
行銷活動是否已封存。 |
取得行銷活動統計資料
根據傳送、開啟、退信、點按連結等活動等活動擷取指定行銷活動的詳細統計資料清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
CampaignId | True | string |
行銷活動識別碼。 |
|
類型
|
Type | True | string |
型別。 |
|
頁面
|
Page | integer |
頁面。 |
|
|
頁面大小
|
PageSize | integer |
頁面大小。 |
|
|
寄件者
|
From | string |
寄件者位址。 |
|
|
發往
|
To | string |
致地址。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
頁面大小
|
Context.Paging.PageSize | integer |
頁面大小。 |
|
當前頁面
|
Context.Paging.CurrentPage | integer |
目前頁面。 |
|
總結果
|
Context.Paging.TotalResults | integer |
總結果。 |
|
總頁數
|
Context.Paging.TotalPageCount | integer |
總頁數。 |
|
排序運算式
|
Context.Paging.SortExpression | string |
排序運算式。 |
|
排序是遞增的
|
Context.Paging.SortIsAscending | boolean |
排序是否遞增。 |
|
Analytics
|
Context.Analytics | array of object | |
|
上下文
|
Context.Analytics.Context | string |
上下文。 |
|
內容名稱
|
Context.Analytics.ContextName | string |
環境定義名稱。 |
|
總計數
|
Context.Analytics.TotalCount | integer |
總計數。 |
|
唯一計數
|
Context.Analytics.UniqueCount | integer |
唯一計數。 |
|
上下文描述
|
Context.Analytics.ContextDescription | string |
內容描述。 |
取得行銷活動詳細資料
傳回一組完整的屬性,詳細描述所要求的行銷活動。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
CampaignId | True | string |
行銷活動識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
ID
|
Context.ID | string |
識別碼。 |
|
名稱
|
Context.Name | string |
名稱。 |
|
主旨
|
Context.Subject | string |
主題。 |
|
網址
|
Context.WebLocation | string |
網站位置。 |
|
HTML 內容
|
Context.HTMLContent | string |
HTML 內容。 |
|
純內容
|
Context.PlainContent | string |
簡單的內容。 |
|
ID
|
Context.Sender.ID | string |
識別碼。 |
|
名稱
|
Context.Sender.Name | string |
名稱。 |
|
Email
|
Context.Sender.Email | string |
電子郵件地址。 |
|
創建日期
|
Context.Sender.CreatedOn | string |
建立時。 |
|
已啟用
|
Context.Sender.IsEnabled | boolean |
是否已啟用。 |
|
SPF 驗證
|
Context.Sender.SpfVerified | boolean |
SPF 是否經過驗證。 |
|
DKIM 驗證
|
Context.Sender.DkimVerified | boolean |
DKIM 是否經過驗證。 |
|
DKIM 公眾
|
Context.Sender.DkimPublic | string |
公共 DKIM。 |
|
交付日期
|
Context.DeliveredOn | string |
當交付時。 |
|
ID
|
Context.ReplyToEmail.ID | string |
識別碼。 |
|
名稱
|
Context.ReplyToEmail.Name | string |
名稱。 |
|
Email
|
Context.ReplyToEmail.Email | string |
電子郵件地址。 |
|
創建日期
|
Context.ReplyToEmail.CreatedOn | string |
建立時。 |
|
已啟用
|
Context.ReplyToEmail.IsEnabled | boolean |
是否已啟用。 |
|
SPF 驗證
|
Context.ReplyToEmail.SpfVerified | boolean |
SPF 是否經過驗證。 |
|
DKIM 驗證
|
Context.ReplyToEmail.DkimVerified | boolean |
DKIM 是否經過驗證。 |
|
DKIM 公眾
|
Context.ReplyToEmail.DkimPublic | string |
公共 DKIM。 |
|
創建日期
|
Context.CreatedOn | string |
建立時。 |
|
更新於
|
Context.UpdatedOn | string |
更新時。 |
|
預定時間
|
Context.ScheduledFor | string |
何時安排。 |
|
Timezone
|
Context.Timezone | string |
時區。 |
|
格式類型
|
Context.FormatType | integer |
格式類型。 |
|
AB 行銷活動資料
|
Context.ABCampaignData | string |
AB 活動資料。 |
|
郵件列表
|
Context.MailingLists | array of object | |
|
郵件清單 ID
|
Context.MailingLists.MailingListID | string |
郵件清單識別碼。 |
|
區段識別碼
|
Context.MailingLists.SegmentID | integer |
區段識別碼。 |
|
確認至
|
Context.ConfirmationTo | string |
確認到。 |
|
地位
|
Context.Status | integer |
狀態。 |
|
是交易性的
|
Context.IsTransactional | boolean |
是否是交易性的。 |
取得連結活動
傳回包含行銷活動連結的清單,以及收件者點按的次數(不重複或總數)。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
CampaignId | True | string |
行銷活動識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
頁面大小
|
Context.Paging.PageSize | integer |
頁面大小。 |
|
當前頁面
|
Context.Paging.CurrentPage | integer |
目前頁面。 |
|
總結果
|
Context.Paging.TotalResults | integer |
總結果。 |
|
總頁數
|
Context.Paging.TotalPageCount | integer |
總頁數。 |
|
排序運算式
|
Context.Paging.SortExpression | string |
排序運算式。 |
|
排序是遞增的
|
Context.Paging.SortIsAscending | boolean |
排序是否遞增。 |
|
Analytics
|
Context.Analytics | array of object | |
|
上下文
|
Context.Analytics.Context | string |
上下文。 |
|
內容名稱
|
Context.Analytics.ContextName | string |
環境定義名稱。 |
|
總計數
|
Context.Analytics.TotalCount | integer |
總計數。 |
|
唯一計數
|
Context.Analytics.UniqueCount | integer |
唯一計數。 |
|
上下文描述
|
Context.Analytics.ContextDescription | string |
內容描述。 |
取得郵件清單詳細資料
擷取指定郵件清單的詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
有統計數據
|
WithStatistics | boolean |
無論是統計數據。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
ID
|
Context.ID | string |
識別碼。 |
|
名稱
|
Context.Name | string |
名稱。 |
|
活躍會員數量
|
Context.ActiveMemberCount | integer |
作用中成員計數。 |
|
退回的會員數量
|
Context.BouncedMemberCount | integer |
退信的成員計數。 |
|
已移除的成員計數
|
Context.RemovedMemberCount | integer |
已移除的成員計數。 |
|
未訂閱會員人數
|
Context.UnsubscribedMemberCount | integer |
取消訂閱的成員計數。 |
|
地位
|
Context.Status | integer |
狀態。 |
|
自訂欄位定義
|
Context.CustomFieldsDefinition | array of object | |
|
ID
|
Context.CustomFieldsDefinition.ID | string |
識別碼。 |
|
名稱
|
Context.CustomFieldsDefinition.Name | string |
名稱。 |
|
上下文
|
Context.CustomFieldsDefinition.Context | string |
上下文。 |
|
是必要的
|
Context.CustomFieldsDefinition.IsRequired | boolean |
是否需要。 |
|
類型
|
Context.CustomFieldsDefinition.Type | integer |
型別。 |
|
作者
|
Context.CreatedBy | string |
創建者。 |
|
創建日期
|
Context.CreatedOn | string |
建立時。 |
|
更新者
|
Context.UpdatedBy | string |
更新者。 |
|
更新於
|
Context.UpdatedOn | string |
更新時。 |
|
ID
|
Context.ImportOperation.ID | integer |
識別碼。 |
|
資料雜湊
|
Context.ImportOperation.DataHash | string |
資料雜湊。 |
|
映射
|
Context.ImportOperation.Mappings | string |
映射。 |
|
電子郵件通知
|
Context.ImportOperation.EmailNotify | string |
電子郵件通知。 |
|
創建日期
|
Context.ImportOperation.CreatedOn | string |
建立時。 |
|
已啟動
|
Context.ImportOperation.StartedOn | string |
當開始時。 |
|
完成日期
|
Context.ImportOperation.CompletedOn | string |
完成後。 |
|
插入總計
|
Context.ImportOperation.TotalInserted | integer |
插入的總計。 |
|
更新總數
|
Context.ImportOperation.TotalUpdated | integer |
總計更新。 |
|
取消訂閱總數
|
Context.ImportOperation.TotalUnsubscribed | integer |
取消訂閱的總數。 |
|
總無效
|
Context.ImportOperation.TotalInvalid | integer |
總數無效。 |
|
忽略總計
|
Context.ImportOperation.TotalIgnored | integer |
總計被忽略了。 |
|
重複總數
|
Context.ImportOperation.TotalDuplicate | integer |
重複總數。 |
|
會員總數
|
Context.ImportOperation.TotalMembers | integer |
成員總數。 |
|
Message
|
Context.ImportOperation.Message | string |
訊息。 |
|
成功
|
Context.ImportOperation.Success | boolean |
是否成功。 |
|
跳過新成員
|
Context.ImportOperation.SkipNewMembers | boolean |
是否跳過新成員。 |
取消排程行銷活動
從行銷活動中移除先前定義的排程日期和時間,以便在已排入佇列或傳送時立即傳遞。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
CampaignId | True | string |
行銷活動識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
取消訂閱帳戶的訂閱者
從帳戶取消訂閱訂閱者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Email
|
True | string |
電子郵件地址。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
建立自定義欄位
在指定的郵件清單中建立新的自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
名稱
|
Name | string |
名稱。 |
|
|
自訂欄位類型
|
CustomFieldType | string |
自訂欄位類型。 |
|
|
選項
|
Options | string |
選項。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
建立草稿廣告活動
在您的帳戶中建立新的草稿行銷活動。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
Name | string |
名稱。 |
|
|
主旨
|
Subject | string |
主題。 |
|
|
寄件者電子郵件
|
SenderEmail | string |
寄件者電子郵件地址。 |
|
|
回覆電子郵件
|
ReplyToEmail | string |
回覆電子郵件地址。 |
|
|
確認至電子郵件
|
ConfirmationToEmail | string |
電子郵件地址的確認。 |
|
|
網址
|
WebLocation | string |
網站位置。 |
|
|
郵件清單 ID
|
MailingListID | string |
郵件清單識別碼。 |
|
|
區段識別碼
|
SegmentID | string |
區段識別碼。 |
|
|
是AB
|
IsAB | string |
這是AB。 |
|
|
AB 行銷活動類型
|
ABCampaignType | string |
AB 行銷活動類型。 |
|
|
B 網址
|
WebLocationB | string |
B 網站位置。 |
|
|
測試時間
|
HoursToTest | string |
測試的時間。 |
|
|
清單百分比
|
ListPercentage | string |
列表百分比。 |
|
|
AB 獲獎者選擇類型
|
ABWinnerSelectionType | string |
AB 獲勝者選擇類型。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
建立郵件清單
在您的帳戶中建立新的空白郵件清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
Name | string |
名稱。 |
|
|
確認頁面
|
ConfirmationPage | string |
確認頁面。 |
|
|
取消訂閱頁面後重定向
|
RedirectAfterUnsubscribePage | string |
取消訂閱頁面後的重定向。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
從郵件列表中取消訂閱
從指定的郵件清單中取消訂閱訂閱者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
Email
|
True | string |
電子郵件地址。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
排定廣告活動
指派行銷活動的排程日期和時間。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
CampaignId | True | string |
行銷活動識別碼。 |
|
日期時間
|
DateTime | True | string |
日期和時間。 |
|
Timezone
|
Timezone | string |
時區。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
新增多個訂閱者
通過一次呼叫在郵件列表中添加多個訂閱者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
具有外部雙重選擇加入
|
HasExternalDoubleOptIn | boolean |
是否有外部雙重選擇加入。 |
|
|
名稱
|
Name | string |
名稱。 |
|
|
Email
|
string |
電子郵件地址。 |
||
|
自訂欄位
|
CustomFields | array of string |
自訂欄位。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | array of object | |
|
ID
|
Context.ID | string |
識別碼。 |
|
名稱
|
Context.Name | string |
名稱。 |
|
Email
|
Context.Email | string |
電子郵件地址。 |
|
創建日期
|
Context.CreatedOn | string |
建立時。 |
|
更新於
|
Context.UpdatedOn | string |
更新時。 |
|
取消訂閱日期
|
Context.UnsubscribedOn | string |
取消訂閱時。 |
|
取消訂閱 ID
|
Context.UnsubscribedFromID | string |
取消訂閱的識別碼。 |
|
訂閱類型
|
Context.SubscribeType | integer |
訂閱類型。 |
|
認購方式
|
Context.SubscribeMethod | integer |
subscribe 方法。 |
|
自訂欄位
|
Context.CustomFields | array of object | |
|
自訂欄位ID
|
Context.CustomFields.CustomFieldID | string |
自訂欄位識別碼。 |
|
名稱
|
Context.CustomFields.Name | string |
名稱。 |
|
價值觀
|
Context.CustomFields.Value | string |
值。 |
|
刪除日期
|
Context.RemovedOn | string |
被刪除了。 |
新增訂閱者
將新訂閱者新增至指定的郵件清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
名稱
|
Name | string |
名稱。 |
|
|
Email
|
string |
電子郵件地址。 |
||
|
具有外部雙重選擇加入
|
HasExternalDoubleOptIn | boolean |
是否有外部雙重選擇加入。 |
|
|
自訂欄位
|
CustomFields | array of string |
自訂欄位。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
ID
|
Context.ID | string |
識別碼。 |
|
名稱
|
Context.Name | string |
名稱。 |
|
Email
|
Context.Email | string |
電子郵件地址。 |
|
創建日期
|
Context.CreatedOn | string |
建立時。 |
|
更新於
|
Context.UpdatedOn | string |
更新時。 |
|
取消訂閱日期
|
Context.UnsubscribedOn | string |
取消訂閱時。 |
|
取消訂閱 ID
|
Context.UnsubscribedFromID | string |
取消訂閱的識別碼。 |
|
訂閱類型
|
Context.SubscribeType | integer |
訂閱類型。 |
|
認購方式
|
Context.SubscribeMethod | integer |
subscribe 方法。 |
|
自訂欄位
|
Context.CustomFields | array of object | |
|
自訂欄位ID
|
Context.CustomFields.CustomFieldID | string |
自訂欄位識別碼。 |
|
名稱
|
Context.CustomFields.Name | string |
名稱。 |
|
價值觀
|
Context.CustomFields.Value | string |
值。 |
|
刪除日期
|
Context.RemovedOn | string |
當取下時。 |
更新廣告活動草稿
更新您帳戶中現有草稿 AB 廣告活動的屬性。 非草稿行銷活動無法更新。 忽略 (AB 分割行銷活動選項) 如果您想要建立一般行銷活動。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
CampaignId | True | string |
行銷活動識別碼。 |
|
名稱
|
Name | string |
名稱。 |
|
|
主旨
|
Subject | string |
主題。 |
|
|
寄件者電子郵件
|
SenderEmail | string |
寄件者電子郵件地址。 |
|
|
回覆電子郵件
|
ReplyToEmail | string |
回覆電子郵件地址。 |
|
|
確認至電子郵件
|
ConfirmationToEmail | string |
電子郵件地址的確認。 |
|
|
網址
|
WebLocation | string |
網站位置。 |
|
|
郵件清單 ID
|
MailingListID | string |
郵件清單識別碼。 |
|
|
區段識別碼
|
SegmentID | string |
區段識別碼。 |
|
|
是AB
|
IsAB | string |
這是AB。 |
|
|
AB 行銷活動類型
|
ABCampaignType | string |
AB 行銷活動類型。 |
|
|
B 網址
|
WebLocationB | string |
B 網站位置。 |
|
|
測試時間
|
HoursToTest | string |
測試的時間。 |
|
|
清單百分比
|
ListPercentage | string |
列表百分比。 |
|
|
AB 獲獎者選擇類型
|
ABWinnerSelectionType | string |
AB 獲勝者選擇類型。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
更新自訂欄位
更新指定郵件清單中現有自訂欄位的屬性。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
自訂欄位ID
|
CustomFieldId | True | string |
自訂欄位識別碼。 |
|
名稱
|
Name | string |
名稱。 |
|
|
自訂欄位類型
|
CustomFieldType | string |
自訂欄位類型。 |
|
|
選項
|
Options | string |
選項。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
更新訂閱者
更新指定郵件清單中的訂閱者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
訂閱者 ID
|
SubscriberId | True | string |
訂閱者識別碼。 |
|
名稱
|
Name | string |
名稱。 |
|
|
具有外部雙重選擇加入
|
HasExternalDoubleOptIn | boolean |
是否有外部雙重選擇加入。 |
|
|
Email
|
string |
電子郵件地址。 |
||
|
自訂欄位
|
CustomFields | array of string |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
ID
|
Context.ID | string |
識別碼。 |
|
名稱
|
Context.Name | string |
名稱。 |
|
Email
|
Context.Email | string |
電子郵件地址。 |
|
創建日期
|
Context.CreatedOn | string |
建立時。 |
|
更新於
|
Context.UpdatedOn | string |
更新時。 |
|
取消訂閱日期
|
Context.UnsubscribedOn | string |
取消訂閱時。 |
|
取消訂閱 ID
|
Context.UnsubscribedFromID | string |
取消訂閱的識別碼。 |
|
訂閱類型
|
Context.SubscribeType | integer |
訂閱類型。 |
|
認購方式
|
Context.SubscribeMethod | integer |
subscribe 方法。 |
|
自訂欄位
|
Context.CustomFields | array of object | |
|
自訂欄位ID
|
Context.CustomFields.CustomFieldID | string |
自訂欄位識別碼。 |
|
名稱
|
Context.CustomFields.Name | string |
名稱。 |
|
價值觀
|
Context.CustomFields.Value | string |
值。 |
|
刪除日期
|
Context.RemovedOn | string |
當取下時。 |
更新郵件清單
更新現有郵件清單的屬性。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
名稱
|
Name | string |
名稱。 |
|
|
確認頁面
|
ConfirmationPage | string |
確認頁面。 |
|
|
取消訂閱頁面後重定向
|
RedirectAfterUnsubscribePage | string |
取消訂閱頁面後的重定向。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
測試行銷活動
將草稿行銷活動的測試電子郵件傳送至您指定要預覽的電子郵件地址清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
CampaignId | True | string |
行銷活動識別碼。 |
|
測試電子郵件
|
TestEmails | True | array of string |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
獲得訂閱者
擷取指定郵件清單中所有訂閱者的清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
頁面
|
Page | integer |
頁面。 |
|
|
頁面大小
|
PageSize | integer |
頁面大小。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
頁面大小
|
Context.Paging.PageSize | integer |
頁面大小。 |
|
當前頁面
|
Context.Paging.CurrentPage | integer |
目前頁面。 |
|
總結果
|
Context.Paging.TotalResults | integer |
總結果。 |
|
總頁數
|
Context.Paging.TotalPageCount | integer |
總頁數。 |
|
排序運算式
|
Context.Paging.SortExpression | string |
排序運算式。 |
|
排序是遞增的
|
Context.Paging.SortIsAscending | boolean |
排序是否遞增。 |
|
Subscribers
|
Context.Subscribers | array of object | |
|
ID
|
Context.Subscribers.ID | string |
識別碼。 |
|
名稱
|
Context.Subscribers.Name | string |
名稱。 |
|
Email
|
Context.Subscribers.Email | string |
電子郵件地址。 |
|
創建日期
|
Context.Subscribers.CreatedOn | string |
建立時。 |
|
更新於
|
Context.Subscribers.UpdatedOn | string |
更新了。 |
|
取消訂閱日期
|
Context.Subscribers.UnsubscribedOn | string |
取消訂閱時。 |
|
取消訂閱 ID
|
Context.Subscribers.UnsubscribedFromID | string |
取消訂閱的識別碼。 |
|
訂閱類型
|
Context.Subscribers.SubscribeType | integer |
訂閱類型。 |
|
認購方式
|
Context.Subscribers.SubscribeMethod | integer |
subscribe 方法。 |
|
自訂欄位
|
Context.Subscribers.CustomFields | array of object | |
|
自訂欄位ID
|
Context.Subscribers.CustomFields.CustomFieldID | string |
自訂欄位識別碼。 |
|
名稱
|
Context.Subscribers.CustomFields.Name | string |
名稱。 |
|
價值觀
|
Context.Subscribers.CustomFields.Value | string |
值。 |
|
刪除日期
|
Context.Subscribers.RemovedOn | string |
當取下時。 |
移除多個訂閱者
從指定的郵件清單中永久移除訂閱者清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
電子郵件
|
Emails | True | string |
電子郵件。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
忽略的電子郵件
|
Context.EmailsIgnored | integer |
這些電子郵件被忽略了。 |
|
已處理的電子郵件
|
Context.EmailsProcessed | integer |
電子郵件已處理。 |
移除自訂欄位
從指定的郵件清單中移除自訂欄位定義。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
自訂欄位ID
|
CustomFieldId | True | string |
自訂欄位識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
移除訂閱者
從指定的郵件清單中永久移除訂閱者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
Email
|
True | string |
電子郵件地址。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
上下文
|
Context | string |
上下文。 |
複製現有行銷活動
建立現有行銷活動的精確副本。 新行銷活動會建立為草稿。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
CampaignId | True | string |
行銷活動識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
ID
|
Context.ID | string |
識別碼。 |
|
名稱
|
Context.Name | string |
名稱。 |
|
主旨
|
Context.Subject | string |
主題。 |
|
網址
|
Context.WebLocation | string |
網站位置。 |
|
HTML 內容
|
Context.HTMLContent | string |
HTML 內容。 |
|
純內容
|
Context.PlainContent | string |
簡單的內容。 |
|
ID
|
Context.Sender.ID | string |
識別碼。 |
|
名稱
|
Context.Sender.Name | string |
名稱。 |
|
Email
|
Context.Sender.Email | string |
電子郵件地址。 |
|
創建日期
|
Context.Sender.CreatedOn | string |
建立時。 |
|
已啟用
|
Context.Sender.IsEnabled | boolean |
是否已啟用。 |
|
SPF 驗證
|
Context.Sender.SpfVerified | boolean |
SPF 是否經過驗證。 |
|
DKIM 驗證
|
Context.Sender.DkimVerified | boolean |
DKIM 是否經過驗證。 |
|
DKIM 公眾
|
Context.Sender.DkimPublic | string |
公共 DKIM。 |
|
交付日期
|
Context.DeliveredOn | string |
當交付時。 |
|
ID
|
Context.ReplyToEmail.ID | string |
識別碼。 |
|
名稱
|
Context.ReplyToEmail.Name | string |
名稱。 |
|
Email
|
Context.ReplyToEmail.Email | string |
電子郵件地址。 |
|
創建日期
|
Context.ReplyToEmail.CreatedOn | string |
建立時。 |
|
已啟用
|
Context.ReplyToEmail.IsEnabled | boolean |
是否已啟用。 |
|
SPF 驗證
|
Context.ReplyToEmail.SpfVerified | boolean |
SPF 是否經過驗證。 |
|
DKIM 驗證
|
Context.ReplyToEmail.DkimVerified | boolean |
DKIM 是否經過驗證。 |
|
DKIM 公眾
|
Context.ReplyToEmail.DkimPublic | string |
公共 DKIM。 |
|
創建日期
|
Context.CreatedOn | string |
建立時。 |
|
更新於
|
Context.UpdatedOn | string |
更新時。 |
|
預定時間
|
Context.ScheduledFor | string |
何時安排。 |
|
Timezone
|
Context.Timezone | string |
時區。 |
|
格式類型
|
Context.FormatType | integer |
格式類型。 |
|
ID
|
Context.ABCampaignData.ID | integer |
識別碼。 |
|
B科目
|
Context.ABCampaignData.SubjectB | string |
B 主題。 |
|
B 簡單內容
|
Context.ABCampaignData.PlainContentB | string |
B 純內容。 |
|
B HTML 內容
|
Context.ABCampaignData.HTMLContentB | string |
B HTML 內容。 |
|
B 網址
|
Context.ABCampaignData.WebLocationB | string |
B 網站位置。 |
|
B 寄件者
|
Context.ABCampaignData.SenderB | string |
B 寄件者。 |
|
測試時間
|
Context.ABCampaignData.HoursToTest | integer |
測試的時間。 |
|
清單百分比
|
Context.ABCampaignData.ListPercentage | integer |
列表百分比。 |
|
AB 行銷活動類型
|
Context.ABCampaignData.ABCampaignType | integer |
AB 行銷活動類型。 |
|
AB 獲獎者選擇類型
|
Context.ABCampaignData.ABWinnerSelectionType | integer |
AB 獲勝者選擇類型。 |
|
A 交付
|
Context.ABCampaignData.DeliveredOnA | string |
A 交付了。 |
|
B 交付時間
|
Context.ABCampaignData.DeliveredOnB | string |
B 隊繼續前進。 |
|
郵件列表
|
Context.MailingLists | array of object | |
|
郵件清單 ID
|
Context.MailingLists.MailingListID | string |
郵件清單識別碼。 |
|
區段識別碼
|
Context.MailingLists.SegmentID | integer |
區段識別碼。 |
|
確認至
|
Context.ConfirmationTo | string |
確認到。 |
|
地位
|
Context.Status | integer |
狀態。 |
|
是交易性的
|
Context.IsTransactional | boolean |
是否是交易性的。 |
通過 ID 獲取訂閱者
在指定的郵件清單中搜尋具有指定唯一識別碼的訂閱者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
訂閱者 ID
|
SubscriberId | True | string |
訂閱者識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
ID
|
Context.ID | string |
識別碼。 |
|
名稱
|
Context.Name | string |
名稱。 |
|
Email
|
Context.Email | string |
電子郵件地址。 |
|
創建日期
|
Context.CreatedOn | string |
建立時。 |
|
更新於
|
Context.UpdatedOn | string |
更新時。 |
|
取消訂閱日期
|
Context.UnsubscribedOn | string |
取消訂閱時。 |
|
取消訂閱 ID
|
Context.UnsubscribedFromID | string |
取消訂閱的識別碼。 |
|
訂閱類型
|
Context.SubscribeType | integer |
訂閱類型。 |
|
認購方式
|
Context.SubscribeMethod | integer |
subscribe 方法。 |
|
自訂欄位
|
Context.CustomFields | array of |
自訂欄位。 |
|
刪除日期
|
Context.RemovedOn | string |
當取下時。 |
通過電子郵件地址獲取訂閱者
在指定的郵件清單中搜尋具有指定電子郵件地址的訂閱者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵件清單 ID
|
MailingListId | True | string |
郵件清單識別碼。 |
|
Email
|
True | string |
電子郵件地址。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
Code | integer |
代碼。 |
|
錯誤
|
Error | string |
錯誤。 |
|
ID
|
Context.ID | string |
識別碼。 |
|
名稱
|
Context.Name | string |
名稱。 |
|
Email
|
Context.Email | string |
電子郵件地址。 |
|
創建日期
|
Context.CreatedOn | string |
建立時。 |
|
更新於
|
Context.UpdatedOn | string |
更新時。 |
|
取消訂閱日期
|
Context.UnsubscribedOn | string |
取消訂閱時。 |
|
取消訂閱 ID
|
Context.UnsubscribedFromID | string |
取消訂閱的識別碼。 |
|
訂閱類型
|
Context.SubscribeType | integer |
訂閱類型。 |
|
認購方式
|
Context.SubscribeMethod | integer |
subscribe 方法。 |
|
自訂欄位
|
Context.CustomFields | array of object | |
|
自訂欄位ID
|
Context.CustomFields.CustomFieldID | string |
自訂欄位識別碼。 |
|
名稱
|
Context.CustomFields.Name | string |
名稱。 |
|
價值觀
|
Context.CustomFields.Value | string |
值。 |
|
刪除日期
|
Context.RemovedOn | string |
當取下時。 |