HubSpot Engagements V2（獨立發佈者）（預覽版）
HubSpot Engagements用於將CRM記錄 up-to更新在HubSpot之外發生的任何互動。 CRM 中的活動報告也以這些數據為依據。
此連接器適用於以下產品和區域：
| 服務 | 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://www.hubspot.com/products/crm |
| 隱私策略 | https://legal.hubspot.com/privacy-policy |
| 類別 | 銷售和客戶關係管理;傳達 |
HubSpot參與v2
HubSpot Engagements用於將CRM記錄 up-to更新在HubSpot之外發生的任何互動。 CRM 中的活動報告也以這些數據為依據。
發行商：Troy Taylor，Hitachi Solutions
先決條件
您必須擁有 HubSpot 帳戶，並且是超級管理員。
取得憑證
登入帳戶後，請前往「設定」-> 「帳戶設定」-> 「整合」-> 「私人應用程式」。 您必須建立私人應用程式，並只指派您要使用動作的範圍。 建立私人應用程式後，您將在私人應用程式的「驗證」區段中擁有存取權杖。
支援的作業
建立呼叫批次
建立一批呼叫。
取得批次呼叫
依內部識別碼或唯一屬性值擷取批次呼叫。
更新呼叫批次
更新一批呼叫。
封存呼叫批次
依 ID 封存一批呼叫。
列出通話
擷取呼叫頁面。 控制透過查詢參數傳 properties 回的內容。
建立通話
使用指定的屬性建立呼叫，並傳回物件的複本，包括識別碼。
讀取物件
擷取以 識別 callId的物件。
callId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
封存物件
將識別為 的 callId 物件移至回收站。
更新物件
對 所識別 callId的物件執行部分更新。
callId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
合併兩個呼叫
合併兩個類型相同的呼叫。
刪除通話 - GDPR
永久刪除通話和所有相關內容以遵循 GDPR。 使用選擇性屬性 idProperty 設定為 email ，以依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
搜尋通話
擷取呼叫清單。
建立一批電子郵件
建立一批電子郵件。
取得一批電子郵件
依內部識別碼或唯一屬性值擷取一批電子郵件。
封存一批電子郵件
按 ID 封存一批電子郵件。
更新電子郵件批次
更新一批電子郵件。
列出電子郵件
擷取電子郵件頁面。 控制透過查詢參數傳 properties 回的內容。
建立電子郵件
建立具有指定屬性的電子郵件，並傳回物件的複本，包括ID。
取得電子郵件
擷取以 識別 emailId的物件。
emailId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
封存電子郵件
將識別為 的 emailId 物件移至回收站。
更新電子郵件
對 所識別 emailId的物件執行部分更新。
emailId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
合併兩封電子郵件
合併兩封類型相同的電子郵件。
刪除電子郵件 - GDPR
永久刪除電子郵件和所有相關內容以遵循 GDPR。 使用選擇性屬性 idProperty 設定為 email ，以依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
搜尋電子郵件
擷取電子郵件清單。
更新會議批次
更新一批會議。
封存會議批次
按 ID 封存一批會議。
取得批次會議
依內部識別碼或唯一屬性值擷取一批會議。
建立一批會議
建立一批會議。
取得會議
擷取以 識別 meetingId的物件。
meetingId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
封存會議
將識別為 的 meetingId 物件移至回收站。
更新會議
對 所識別 meetingId的物件執行部分更新。
meetingId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
列出會議
擷取會議頁面。 控制透過查詢參數傳 properties 回的內容。
建立會議
使用指定的屬性建立會議，並傳回物件的複本，包括識別碼。
合併兩個會議
合併兩個類型相同的會議。
刪除會議 - GDPR
永久刪除會議和所有相關內容以遵循 GDPR。 使用選擇性屬性 idProperty 設定為 email ，以依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
搜尋會議
擷取會議清單。
獲取一批筆記
依內部 ID 或唯一屬性值擷取一批筆記。
存檔筆記批次
按 ID 存檔一批筆記。
更新筆記批次
更新一批筆記。
建立一批筆記
建立一批筆記。
清單筆記
擷取一頁註釋。 控制透過查詢參數傳 properties 回的內容。
建立筆記
建立具有指定屬性的附註，並傳回物件的複本，包括識別碼。
取得備註
擷取以 識別 noteId的物件。
noteId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
存檔註釋
將識別為 的 noteId 物件移至回收站。
更新說明
對 所識別 noteId的物件執行部分更新。
noteId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
合併兩個筆記
合併兩個相同類型的筆記。
刪除備註 - GDPR
永久刪除附註和所有相關內容以遵循 GDPR。 使用選擇性屬性 idProperty 設定為 email ，以依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
搜尋備註
擷取附註清單。
取得一批郵政郵件
依內部識別碼或唯一屬性值擷取一批郵寄郵件。
封存一批郵政郵件
按 ID 存檔一批郵政郵件。
建立一批郵政郵件
建立一批郵寄郵件。
更新一批郵政郵件
更新一批郵政郵件。
列出郵政郵件
擷取一頁郵政郵件。 控制透過查詢參數傳 properties 回的內容。
建立郵政郵件
建立具有指定屬性的郵寄郵件，並傳回物件的複本，包括 ID。
取得郵寄郵件
擷取以 識別 postalMailId的物件。
postalMailId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
封存郵政郵件
將識別為 的 postalMailId 物件移至回收站。
更新郵寄郵件
對 所識別 postalMailId的物件執行部分更新。
postalMailId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
合併兩封郵件
合併兩封相同類型的郵件。
刪除郵寄郵件 - GDPR
永久刪除郵寄郵件和所有相關內容以遵循 GDPR。 使用選擇性屬性 idProperty 設定為 email ，以依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
搜尋郵政郵件
擷取郵寄郵件清單。
封存工作批次
依 ID 封存一批任務。
建立一批工作
建立一批工作。
更新工作批次
更新一批工作。
取得批次工作
依內部識別碼或唯一屬性值擷取一批工作。
取得任務
擷取以 識別 taskId的物件。
taskId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
封存工作
將識別為 的 taskId 物件移至回收站。
更新工作
對 所識別 taskId的物件執行部分更新。
taskId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
列出工作
擷取工作頁面。 控制透過查詢參數傳 properties 回的內容。
建立任務
建立具有指定屬性的工作，並傳回物件的複本，包括識別碼。 提供了用於創建標準任務的文件和示例。
合併兩個工作
合併兩個類型相同的任務。
刪除工作 - GDPR
永久刪除任務和所有相關內容以遵循 GDPR。 使用選擇性屬性 idProperty 設定為 email ，以依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
搜尋任務
擷取任務清單。
更新通訊批次
更新一批通訊。
封存通訊批次
按 ID 存檔一批通信。
建立一批通訊
建立一批通訊。
取得一批通訊
依內部識別碼或唯一屬性值擷取一批通訊。
列出通訊
擷取通訊頁面。 控制透過查詢參數傳 properties 回的內容。
建立溝通
建立與指定屬性的通訊，並傳回物件的複本，包括識別碼。
進行溝通
擷取以 識別 communicationId的物件。
communicationId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
存檔通訊
將識別為 的 communicationId 物件移至回收站。
更新通訊
對 所識別 communicationId的物件執行部分更新。
communicationId 依預設，參照內部物件識別碼，或選擇性地查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
合併兩個通訊
合併兩個相同類型的通訊。
刪除通訊 - GDPR
永久刪除通訊和所有相關內容以遵循 GDPR。 使用選擇性屬性 idProperty 設定為 email ，以依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
搜尋通訊
擷取通訊清單。
已知問題和限制
目前沒有已知問題。
正在建立連線
連接器支援下列驗證類型：
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用：所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 存取權杖 （以「持有人YOUR_ACCESS_TOKEN」的形式） | securestring | 此 API 的存取權杖 （以「持有人YOUR_ACCESS_TOKEN」的形式） | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 列出工作 |
擷取工作頁面。 控制透過查詢參數傳 |
| 列出會議 |
擷取會議頁面。 控制透過查詢參數傳 |
| 列出通訊 |
擷取通訊頁面。 控制透過查詢參數傳 |
| 列出通話 |
擷取呼叫頁面。 控制透過查詢參數傳 |
| 列出郵政郵件 |
擷取一頁郵政郵件。 控制透過查詢參數傳 |
| 列出電子郵件 |
擷取電子郵件頁面。 控制透過查詢參數傳 |
| 刪除備註 - GDPR |
永久刪除附註和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。 |
| 刪除工作 - GDPR |
永久刪除任務和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。 |
| 刪除會議 - GDPR |
永久刪除會議和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。 |
| 刪除通訊 - GDPR |
永久刪除通訊和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。 |
| 刪除通話 - GDPR |
永久刪除通話和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。 |
| 刪除郵寄郵件 - GDPR |
永久刪除郵寄郵件和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。 |
| 刪除電子郵件 - GDPR |
永久刪除電子郵件和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。 |
| 取得一批通訊 |
依內部識別碼或唯一屬性值擷取一批通訊。 |
| 取得一批郵政郵件 |
依內部識別碼或唯一屬性值擷取一批郵寄郵件。 |
| 取得一批電子郵件 |
依內部識別碼或唯一屬性值擷取一批電子郵件。 |
| 取得任務 |
擷取由 'taskId' 識別的物件。 'taskId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 |
| 取得備註 |
擷取由「noteId」識別的物件。 'noteId' 預設是指內部物件 ID，或選擇性地參考查詢參數所 |
| 取得批次呼叫 |
依內部識別碼或唯一屬性值擷取批次呼叫。 |
| 取得批次工作 |
依內部識別碼或唯一屬性值擷取一批工作。 |
| 取得批次會議 |
依內部識別碼或唯一屬性值擷取一批會議。 |
| 取得會議 |
擷取由 'meetingId' 識別的物件。 'meetingId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 |
| 取得郵寄郵件 |
擷取由 'postalMailId' 識別的物件。 'postalMailId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 |
| 取得電子郵件 |
擷取由「emailId」識別的物件。 'emailId' 預設是指內部物件 ID，或選擇性地參考查詢參數所 |
| 合併兩個呼叫 |
合併兩個類型相同的呼叫。 |
| 合併兩個工作 |
合併兩個類型相同的任務。 |
| 合併兩個會議 |
合併兩個類型相同的會議。 |
| 合併兩個筆記 |
合併兩個相同類型的筆記。 |
| 合併兩個通訊 |
合併兩個相同類型的通訊。 |
| 合併兩封郵件 |
合併兩封相同類型的郵件。 |
| 合併兩封電子郵件 |
合併兩封類型相同的電子郵件。 |
| 存檔筆記批次 |
按 ID 存檔一批筆記。 |
| 存檔註釋 |
將以 'noteId' 識別的物件移至回收筒。 |
| 存檔通訊 |
將 'communicationId' 所識別的物件移至回收站。 |
| 封存一批郵政郵件 |
按 ID 存檔一批郵政郵件。 |
| 封存一批電子郵件 |
按 ID 封存一批電子郵件。 |
| 封存呼叫批次 |
依 ID 封存一批呼叫。 |
| 封存工作 |
將 'taskId' 標識的物件移至回收站。 |
| 封存工作批次 |
依 ID 封存一批任務。 |
| 封存會議 |
將 'meetingId' 識別的物件移至資源回收筒。 |
| 封存會議批次 |
按 ID 封存一批會議。 |
| 封存物件 |
將 'callId' 識別的物件移至回收站。 |
| 封存通訊批次 |
按 ID 存檔一批通信。 |
| 封存郵政郵件 |
將 'postalMailId' 識別的物件移至回收站。 |
| 封存電子郵件 |
將「emailId」識別的物件移至回收筒。 |
| 建立一批工作 |
建立一批工作。 |
| 建立一批會議 |
建立一批會議。 |
| 建立一批筆記 |
建立一批筆記。 |
| 建立一批通訊 |
建立一批通訊。 |
| 建立一批郵政郵件 |
建立一批郵寄郵件。 |
| 建立一批電子郵件 |
建立一批電子郵件。 |
| 建立任務 |
建立具有指定屬性的工作，並傳回物件的複本，包括識別碼。 提供了用於創建標準任務的文件和示例。 |
| 建立呼叫批次 |
建立一批呼叫。 |
| 建立會議 |
使用指定的屬性建立會議，並傳回物件的複本，包括識別碼。 |
| 建立溝通 |
建立與指定屬性的通訊，並傳回物件的複本，包括識別碼。 |
| 建立筆記 |
建立具有指定屬性的附註，並傳回物件的複本，包括識別碼。 |
| 建立通話 |
使用指定的屬性建立呼叫，並傳回物件的複本，包括識別碼。 |
| 建立郵政郵件 |
建立具有指定屬性的郵寄郵件，並傳回物件的複本，包括 ID。 |
| 建立電子郵件 |
建立具有指定屬性的電子郵件，並傳回物件的複本，包括ID。 |
| 搜尋任務 |
擷取任務清單。 |
| 搜尋備註 |
擷取附註清單。 |
| 搜尋會議 |
擷取會議清單。 |
| 搜尋通訊 |
擷取通訊清單。 |
| 搜尋通話 |
擷取呼叫清單。 |
| 搜尋郵政郵件 |
擷取郵寄郵件清單。 |
| 搜尋電子郵件 |
擷取電子郵件清單。 |
| 更新一批郵政郵件 |
更新一批郵政郵件。 |
| 更新呼叫批次 |
更新一批呼叫。 |
| 更新工作 |
對 'taskId' 所識別的物件執行部分更新。 'taskId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 |
| 更新工作批次 |
更新一批工作。 |
| 更新會議 |
對 'meetingId' 所識別的物件執行部分更新。 'meetingId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 |
| 更新會議批次 |
更新一批會議。 |
| 更新物件 |
執行 'callId' 所識別物件的部分更新。 'callId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 |
| 更新筆記批次 |
更新一批筆記。 |
| 更新說明 |
對 'noteId' 所識別的物件執行部分更新。 'noteId' 預設是指內部物件 ID，或選擇性地參考查詢參數所 |
| 更新通訊 |
執行 'communicationId' 所識別物件的部分更新。 'communicationId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 |
| 更新通訊批次 |
更新一批通訊。 |
| 更新郵寄郵件 |
對 'postalMailId' 所識別的物件執行部分更新。 'postalMailId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 |
| 更新電子郵件 |
對 'emailId' 所識別的物件執行部分更新。 'emailId' 預設是指內部物件 ID，或選擇性地參考查詢參數所 |
| 更新電子郵件批次 |
更新一批電子郵件。 |
| 清單筆記 |
擷取一頁註釋。 控制透過查詢參數傳 |
| 獲取一批筆記 |
依內部 ID 或唯一屬性值擷取一批筆記。 |
| 讀取物件 |
擷取由 'callId' 識別的物件。 'callId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 |
| 進行溝通 |
擷取由 'communicationId' 識別的物件。 'communicationId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 |
列出工作
擷取工作頁面。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
限制
|
limit | integer |
限制。 |
|
|
之後
|
after | string |
之後。 |
|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
列出會議
擷取會議頁面。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
限制
|
limit | integer |
限制。 |
|
|
之後
|
after | string |
之後。 |
|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
列出通訊
擷取通訊頁面。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
限制
|
limit | integer |
限制。 |
|
|
之後
|
after | string |
之後。 |
|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
列出通話
擷取呼叫頁面。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
限制
|
limit | integer |
限制。 |
|
|
之後
|
after | string |
之後。 |
|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
列出郵政郵件
擷取一頁郵政郵件。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
限制
|
limit | integer |
限制。 |
|
|
之後
|
after | string |
之後。 |
|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
列出電子郵件
擷取電子郵件頁面。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
限制
|
limit | integer |
限制。 |
|
|
之後
|
after | string |
之後。 |
|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
刪除備註 - GDPR
永久刪除附註和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
物件識別碼
|
objectId | string |
物件識別碼。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
- response
- string
刪除工作 - GDPR
永久刪除任務和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
物件識別碼
|
objectId | string |
物件識別碼。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
- response
- string
刪除會議 - GDPR
永久刪除會議和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
物件識別碼
|
objectId | string |
物件識別碼。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
- response
- string
刪除通訊 - GDPR
永久刪除通訊和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
物件識別碼
|
objectId | string |
物件識別碼。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
- response
- string
刪除通話 - GDPR
永久刪除通話和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
物件識別碼
|
objectId | string |
物件識別碼。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
- response
- string
刪除郵寄郵件 - GDPR
永久刪除郵寄郵件和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
物件識別碼
|
objectId | string |
物件識別碼。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
- response
- string
刪除電子郵件 - GDPR
永久刪除電子郵件和所有相關內容以遵循 GDPR。 使用設定為「電子郵件」的選擇性屬性「idProperty」，依電子郵件地址識別連絡人。 如果找不到電子郵件地址，該電子郵件地址將被添加到阻止列表中並阻止將來使用它。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
物件識別碼
|
objectId | string |
物件識別碼。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
- response
- string
取得一批通訊
依內部識別碼或唯一屬性值擷取一批通訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID
|
id | string |
識別碼。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | array of string |
有歷史的屬性。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
取得一批郵政郵件
依內部識別碼或唯一屬性值擷取一批郵寄郵件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID
|
id | string |
識別碼。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | array of string |
有歷史的屬性。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
取得一批電子郵件
依內部識別碼或唯一屬性值擷取一批電子郵件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID
|
id | string |
識別碼。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | array of string |
有歷史的屬性。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
取得任務
擷取由 'taskId' 識別的物件。 'taskId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
工作識別碼
|
taskId | True | string |
任務識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
取得備註
擷取由「noteId」識別的物件。 'noteId' 預設是指內部物件 ID，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
附註 ID
|
noteId | True | string |
附註識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
取得批次呼叫
依內部識別碼或唯一屬性值擷取批次呼叫。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID
|
id | string |
識別碼。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | array of string |
有歷史的屬性。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
取得批次工作
依內部識別碼或唯一屬性值擷取一批工作。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID
|
id | string |
識別碼。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | array of string |
有歷史的屬性。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
取得批次會議
依內部識別碼或唯一屬性值擷取一批會議。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID
|
id | string |
識別碼。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | array of string |
有歷史的屬性。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
取得會議
擷取由 'meetingId' 識別的物件。 'meetingId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
會議標識符
|
meetingId | True | string |
會議識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
取得郵寄郵件
擷取由 'postalMailId' 識別的物件。 'postalMailId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
郵政郵件 ID
|
postalMailId | True | string |
郵政郵件識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
取得電子郵件
擷取由「emailId」識別的物件。 'emailId' 預設是指內部物件 ID，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
電子郵件識別碼
|
emailId | True | string |
電子郵件識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
合併兩個呼叫
合併兩個類型相同的呼叫。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要合併的物件識別碼
|
objectIdToMerge | string |
要合併的物件識別碼。 |
|
|
主要物件識別碼
|
primaryObjectId | string |
主要物件識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
合併兩個工作
合併兩個類型相同的任務。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要合併的物件識別碼
|
objectIdToMerge | string |
要合併的物件識別碼。 |
|
|
主要物件識別碼
|
primaryObjectId | string |
主要物件識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
合併兩個會議
合併兩個類型相同的會議。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要合併的物件識別碼
|
objectIdToMerge | string |
要合併的物件識別碼。 |
|
|
主要物件識別碼
|
primaryObjectId | string |
主要物件識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
合併兩個筆記
合併兩個相同類型的筆記。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要合併的物件識別碼
|
objectIdToMerge | string |
要合併的物件識別碼。 |
|
|
主要物件識別碼
|
primaryObjectId | string |
主要物件識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
合併兩個通訊
合併兩個相同類型的通訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要合併的物件識別碼
|
objectIdToMerge | string |
要合併的物件識別碼。 |
|
|
主要物件識別碼
|
primaryObjectId | string |
主要物件識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
合併兩封郵件
合併兩封相同類型的郵件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要合併的物件識別碼
|
objectIdToMerge | string |
要合併的物件識別碼。 |
|
|
主要物件識別碼
|
primaryObjectId | string |
主要物件識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
合併兩封電子郵件
合併兩封類型相同的電子郵件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要合併的物件識別碼
|
objectIdToMerge | string |
要合併的物件識別碼。 |
|
|
主要物件識別碼
|
primaryObjectId | string |
主要物件識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
存檔筆記批次
存檔註釋
將以 'noteId' 識別的物件移至回收筒。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
附註 ID
|
noteId | True | string |
附註識別碼。 |
傳回
- response
- string
存檔通訊
將 'communicationId' 所識別的物件移至回收站。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
通訊ID
|
communicationId | True | string |
通訊識別碼。 |
傳回
- response
- string
封存一批郵政郵件
封存一批電子郵件
封存呼叫批次
封存工作
將 'taskId' 標識的物件移至回收站。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作識別碼
|
taskId | True | string |
任務識別碼。 |
傳回
- response
- string
封存工作批次
封存會議
將 'meetingId' 識別的物件移至資源回收筒。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
會議標識符
|
meetingId | True | string |
會議識別碼。 |
傳回
- response
- string
封存會議批次
封存物件
將 'callId' 識別的物件移至回收站。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
通話 ID
|
callId | True | string |
呼叫識別碼。 |
傳回
- response
- string
封存通訊批次
封存郵政郵件
將 'postalMailId' 識別的物件移至回收站。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
郵政郵件 ID
|
postalMailId | True | string |
郵政郵件識別碼。 |
傳回
- response
- string
封存電子郵件
將「emailId」識別的物件移至回收筒。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
電子郵件識別碼
|
emailId | True | string |
電子郵件識別碼。 |
傳回
- response
- string
建立一批工作
建立一批工作。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
建立一批會議
建立一批會議。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
建立一批筆記
建立一批筆記。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
建立一批通訊
建立一批通訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
建立一批郵政郵件
建立一批郵寄郵件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
建立一批電子郵件
建立一批電子郵件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
建立任務
建立具有指定屬性的工作，並傳回物件的複本，包括識別碼。 提供了用於創建標準任務的文件和示例。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
建立呼叫批次
建立一批呼叫。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
建立會議
使用指定的屬性建立會議，並傳回物件的複本，包括識別碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
建立溝通
建立與指定屬性的通訊，並傳回物件的複本，包括識別碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
建立筆記
建立具有指定屬性的附註，並傳回物件的複本，包括識別碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
建立通話
使用指定的屬性建立呼叫，並傳回物件的複本，包括識別碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
建立郵政郵件
建立具有指定屬性的郵寄郵件，並傳回物件的複本，包括 ID。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
建立電子郵件
建立具有指定屬性的電子郵件，並傳回物件的複本，包括ID。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
關聯類別
|
associationCategory | string |
關聯類別。 |
|
|
關聯類型識別碼
|
associationTypeId | string |
關聯類型識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
搜尋任務
擷取任務清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
之後
|
after | string |
之後。 |
|
|
Operator
|
operator | string |
運算子。 |
|
|
屬性名稱
|
propertyName | string |
屬性名稱。 |
|
|
價值觀
|
value | string |
值。 |
|
|
高價值
|
highValue | string |
高價值。 |
|
|
價值觀
|
values | array of string |
價值觀。 |
|
|
限制
|
limit | string |
限制。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
排序
|
sorts | array of string |
種類。 |
|
|
Query
|
query | string |
查詢。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
總數
|
total | integer |
總計。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
搜尋備註
擷取附註清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
之後
|
after | string |
之後。 |
|
|
Operator
|
operator | string |
運算子。 |
|
|
屬性名稱
|
propertyName | string |
屬性名稱。 |
|
|
價值觀
|
value | string |
值。 |
|
|
高價值
|
highValue | string |
高價值。 |
|
|
價值觀
|
values | array of string |
價值觀。 |
|
|
限制
|
limit | string |
限制。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
排序
|
sorts | array of string |
種類。 |
|
|
Query
|
query | string |
查詢。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
總數
|
total | integer |
總計。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
搜尋會議
擷取會議清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
之後
|
after | string |
之後。 |
|
|
Operator
|
operator | string |
運算子。 |
|
|
屬性名稱
|
propertyName | string |
屬性名稱。 |
|
|
價值觀
|
value | string |
值。 |
|
|
高價值
|
highValue | string |
高價值。 |
|
|
價值觀
|
values | array of string |
價值觀。 |
|
|
限制
|
limit | string |
限制。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
排序
|
sorts | array of string |
種類。 |
|
|
Query
|
query | string |
查詢。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
總數
|
total | integer |
總計。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
搜尋通訊
擷取通訊清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
之後
|
after | string |
之後。 |
|
|
Operator
|
operator | string |
運算子。 |
|
|
屬性名稱
|
propertyName | string |
屬性名稱。 |
|
|
價值觀
|
value | string |
值。 |
|
|
高價值
|
highValue | string |
高價值。 |
|
|
價值觀
|
values | array of string |
價值觀。 |
|
|
限制
|
limit | string |
限制。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
排序
|
sorts | array of string |
種類。 |
|
|
Query
|
query | string |
查詢。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
總數
|
total | integer |
總計。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
搜尋通話
擷取呼叫清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
之後
|
after | string |
之後。 |
|
|
Operator
|
operator | string |
運算子。 |
|
|
屬性名稱
|
propertyName | string |
屬性名稱。 |
|
|
價值觀
|
value | string |
值。 |
|
|
高價值
|
highValue | string |
高價值。 |
|
|
價值觀
|
values | array of string |
價值觀。 |
|
|
限制
|
limit | string |
限制。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
排序
|
sorts | array of string |
種類。 |
|
|
Query
|
query | string |
查詢。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
總數
|
total | integer |
總計。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
搜尋郵政郵件
擷取郵寄郵件清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
之後
|
after | string |
之後。 |
|
|
Operator
|
operator | string |
運算子。 |
|
|
屬性名稱
|
propertyName | string |
屬性名稱。 |
|
|
價值觀
|
value | string |
值。 |
|
|
高價值
|
highValue | string |
高價值。 |
|
|
價值觀
|
values | array of string |
價值觀。 |
|
|
限制
|
limit | string |
限制。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
排序
|
sorts | array of string |
種類。 |
|
|
Query
|
query | string |
查詢。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
總數
|
total | integer |
總計。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
搜尋電子郵件
擷取電子郵件清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
之後
|
after | string |
之後。 |
|
|
Operator
|
operator | string |
運算子。 |
|
|
屬性名稱
|
propertyName | string |
屬性名稱。 |
|
|
價值觀
|
value | string |
值。 |
|
|
高價值
|
highValue | string |
高價值。 |
|
|
價值觀
|
values | array of string |
價值觀。 |
|
|
限制
|
limit | string |
限制。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
排序
|
sorts | array of string |
種類。 |
|
|
Query
|
query | string |
查詢。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
總數
|
total | integer |
總計。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
更新一批郵政郵件
更新一批郵政郵件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
更新呼叫批次
更新一批呼叫。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
更新工作
對 'taskId' 所識別的物件執行部分更新。 'taskId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
工作識別碼
|
taskId | True | string |
任務識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
更新工作批次
更新一批工作。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
更新會議
對 'meetingId' 所識別的物件執行部分更新。 'meetingId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
會議標識符
|
meetingId | True | string |
會議識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
更新會議批次
更新一批會議。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
更新物件
執行 'callId' 所識別物件的部分更新。 'callId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
通話 ID
|
callId | True | string |
呼叫識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
更新筆記批次
更新一批筆記。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
更新說明
對 'noteId' 所識別的物件執行部分更新。 'noteId' 預設是指內部物件 ID，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
附註 ID
|
noteId | True | string |
附註識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
更新通訊
執行 'communicationId' 所識別物件的部分更新。 'communicationId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
通訊ID
|
communicationId | True | string |
通訊識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
更新通訊批次
更新一批通訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
更新郵寄郵件
對 'postalMailId' 所識別的物件執行部分更新。 'postalMailId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
郵政郵件 ID
|
postalMailId | True | string |
郵政郵件識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
更新電子郵件
對 'emailId' 所識別的物件執行部分更新。 'emailId' 預設是指內部物件 ID，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 提供的屬性值將會被覆寫。 唯讀和不存在的屬性將被忽略。 屬性值可以透過傳遞空字串來清除。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
電子郵件識別碼
|
emailId | True | string |
電子郵件識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
更新電子郵件批次
更新一批電子郵件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
清單筆記
擷取一頁註釋。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
限制
|
limit | integer |
限制。 |
|
|
之後
|
after | string |
之後。 |
|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
之後
|
paging.next.after | string |
之後。 |
|
Link
|
paging.next.link | string |
鏈接。 |
獲取一批筆記
依內部 ID 或唯一屬性值擷取一批筆記。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID
|
id | string |
識別碼。 |
|
|
屬性
|
properties | array of string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | array of string |
有歷史的屬性。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
存檔於
|
results.archivedAt | string |
存檔時。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
讀取物件
擷取由 'callId' 識別的物件。 'callId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
通話 ID
|
callId | True | string |
呼叫識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
進行溝通
擷取由 'communicationId' 識別的物件。 'communicationId' 預設是指內部物件識別碼，或選擇性地參考查詢參數所 idProperty 指定的任何唯一屬性值。 控制透過查詢參數傳 properties 回的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
屬性
|
properties | string |
屬性。 |
|
|
有歷史的房產
|
propertiesWithHistory | string |
有歷史的屬性。 |
|
|
協會
|
associations | string |
協會。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
ID 屬性
|
idProperty | string |
識別碼屬性。 |
|
|
通訊ID
|
communicationId | True | string |
通訊識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
更新於
|
updatedAt | string |
更新時。 |
|
Archived
|
archived | boolean |
是否存檔。 |
|
存檔於
|
archivedAt | string |
存檔時。 |
定義
字串
這是基本資料類型「string」。