Almabase （預覽版）
Almabase 是世界上最受歡迎的校友管理軟件，用於構建以校友為中心的計劃，以提高參與度、捐助者參與度並舉辦引人入勝的在線社區。
此連接器適用於以下產品和區域：
| 服務 | 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） |
| 連絡人 | |
|---|---|
| 名稱 | Almabase 支援 |
| URL | https://docs.almabase.com |
| help@almabase.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 阿爾馬貝斯公司 |
| 網站 | https://almabase.com |
| 隱私策略 | https://www.almabase.com/ecloud-privacy-policy |
| 類別 | 銷售和客戶關係管理;生產力 |
Almabase 為教育機構提供軟件工具和策略，以建立以校友為中心的計劃，將未參與的校友變成終身支持者。
此連接器建置在 Almabase API 和 Webhook 之上，並提供操作來幫助管理 Almabase 中找到的實體，包括：
- 記錄（成分股）
- 禮物
- 活動
- 參與接觸點
- 表單
- 項
- 捐贈頁面
- 點對點籌款活動
- 不勝枚舉...
先決條件
若要使用此連接器，
- 您必須擁有有效的 Almabase 訂閱。
- 您必須具有網站管理員角色。
如何取得認證
- 登入 Almabase 提供的管理入口網站。
- 導覽至
API's & TokensSettings。 - 點選
Add Auth Token，並填寫description，並設定令牌expiry date & time。 - 記下（
Workflow Access Token單擊要複製到剪貼板上的令牌）。 - 在 Power Automate 上建立新連線時使用 。
Workflow Access Token
開始使用連接器
常見用例
- 贈送禮物後，發送個性化消息和禮品收據。
- 在 Slack、Gmail 或任何其他社交媒體上記錄參與活動時，請使用動作將
Create Custom Touchpoint參與活動新增至 Almabase 上的 Engagement Studio。 - 當在禮物、活動註冊或表單提交中找到新的電子郵件地址 （遺失的校友） 時，請將該電子郵件地址新增至 Almabase 上的記錄或 Raiser's Edge 上的選區或 Salesforce 上的連絡人。
- 設計 Almabase 和 Blackbaud Raiser's Edge 之間的雙向資料同步。
- 設計 Almabase 和 Salesforce 之間的雙向資料同步。
已知問題與限制
- 禮物觸發器僅在 Almabase 上進行在線支付時才有效。 手動新增的禮物不會觸發流程。
正在建立連線
連接器支援下列驗證類型：
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用：所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 網域網址 | 字串 | 指定您的 Almabase 網域網址，例如 https://your.domain.com | 對 |
| API 金鑰 | securestring | 使用者的 API 金鑰 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 列出事件 |
傳回所有事件的清單。 |
| 列出基金 |
傳回資金清單 |
| 列出捐贈頁面 |
傳回給予頁面的清單。 |
| 列出禮物 |
傳回禮物清單。 |
| 列出聯絡人 |
傳回事件上所有連絡人的清單。 |
| 列出表單 |
取得表單清單。 |
| 列出記錄 |
傳回記錄清單。 |
| 列出記錄的電子郵件地址 |
傳回記錄的電子郵件地址清單。 |
| 刪除記錄的電子郵件地址 |
刪除記錄的電子郵件地址。 |
| 取得活動 |
傳回事件的相關資訊。 |
| 取得記錄 |
傳回記錄的相關資訊。 |
| 取得記錄的電子郵件地址 |
傳回記錄電子郵件地址的相關資訊。 |
| 建立事件 |
建立新事件。 |
| 建立基金 |
建立新基金。 |
| 建立接觸點 |
將新的自訂接觸點傳送至 Almabase。 |
| 建立記錄 |
建立新記錄。 |
| 建立記錄的電子郵件地址 |
為記錄建立新的電子郵件地址。 |
| 提交表單 |
傳回表單提交的相關資訊。 |
| 提交表單 |
為表單建立新的表單提交 |
| 新增連絡人 |
將連絡人新增至事件。 |
| 更新基金 |
更新基金。 |
| 更新活動 |
更新事件。 |
| 更新禮物 |
更新禮物 |
| 更新記錄 |
更新記錄。 |
| 更新記錄的電子郵件地址 |
更新記錄的欄位電子郵件地址 |
| 更新連絡人 |
更新事件的連絡人。 |
| 獲取捐贈頁面 |
傳回有關捐贈頁面的資訊。 |
| 獲得基金 |
傳回基金的相關資訊。 |
| 獲得禮物 |
傳回有關禮物的資訊。 |
| 製作禮物 |
創造一份新禮物。 |
列出事件
傳回所有事件的清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
依外部資料庫識別碼搜尋
|
external_database_id | string |
依外部資料庫 ID 搜尋事件。 |
|
|
Fields
|
fields | array |
回應中以逗號分隔的欄位清單。 |
傳回
- response
- array of v1.EventApi.EventRead
列出基金
傳回資金清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Fields
|
fields | array |
回應中以逗號分隔的欄位清單。 |
傳回
- response
- array of v1.GivingApi.FundRead
列出捐贈頁面
傳回給予頁面的清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Fields
|
fields | array |
回應中以逗號分隔的欄位清單。 |
傳回
- response
- array of v1.GivingApi.GivingPageRead
列出禮物
傳回禮物清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
地位
|
status | True | string |
根據狀態過濾禮物。 |
|
捐贈頁面
|
campaign | integer |
系統生成的 ID 以唯一標識捐贈頁面。 |
|
|
依禮品群組識別碼篩選
|
group_id | uuid |
系統產生的 ID，以唯一識別禮品群組或清單。 |
|
|
應該有空批號嗎？
|
batch_number__isnull | boolean |
根據禮物是否有批號來過濾禮物。 |
|
|
應該有空的外部資料庫 ID？
|
external_database_id__isnull | boolean |
根據禮物是否已經有外部數據庫 ID 來過濾禮物。 注意：具有外部資料庫 ID 的禮物已推送到外部資料庫。 |
|
|
依外部資料庫識別碼篩選
|
external_database_id | string |
根據外部資料庫 ID 篩選禮物。 |
|
|
按捐贈者電子郵件篩選
|
donor_email | string |
根據捐贈者電子郵件地址過濾禮物 |
|
|
搜尋方式
|
search | string |
按姓名或電子郵件地址搜索禮物。 |
|
|
Fields
|
fields | array |
回應中以逗號分隔的欄位清單。 |
|
|
頁面大小
|
page_size | integer |
代表要傳回的記錄數目。 預設值為 10。 最大值為 50。 |
|
|
頁碼
|
page | integer |
表示頁碼 （偏移）。 用於分頁。 |
|
|
訂購方式
|
ordering | string |
定義回覆中禮物的順序。 「-」前綴代表降序，缺少前置詞會以升序傳回結果。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
下一個結果網址
|
nextlink | uri |
下一頁結果集的URL。 用於分頁。 |
|
先前的結果網址
|
previouslink | uri |
上一組結果的 URL。 用於分頁。 |
|
禮物總數
|
total | integer |
給定過濾器的禮物總數 |
|
禮物
|
value | array of v1.GivingApi.GiftRead |
針對給定篩選器退回的禮物清單。 結果是分頁的。 |
列出聯絡人
傳回事件上所有連絡人的清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
id | True | integer |
系統產生的 ID 以唯一識別事件。 |
傳回
列出表單
取得表單清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Fields
|
fields | array |
回應中以逗號分隔的欄位清單。 |
傳回
- response
- array of v1.FormApi.FormRead
列出記錄
傳回記錄清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
按名稱搜尋
|
search | string |
依名稱搜尋記錄。 |
|
|
按電子郵件地址搜尋
|
email_addresses__address | string |
依電子郵件地址搜尋記錄。 |
|
|
依外部資料庫識別碼搜尋
|
external_database_id | string |
依外部資料庫 ID 搜尋記錄。 |
|
|
Fields
|
fields | array |
回應中以逗號分隔的欄位清單。 |
|
|
更新日期或之後
|
updated_at__gte | date-time |
在日期或之後更新。 |
|
|
建立日期或之後
|
created_at__gte | date-time |
在日期當天或之後建立。 |
|
|
頁面大小
|
page_size | integer |
代表要傳回的記錄數目。 預設值為 10。 最大值為 50。 |
|
|
頁碼
|
page | integer |
表示頁碼 （偏移）。 用於分頁。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
下一個結果網址
|
nextlink | uri |
下一頁結果集的URL。 用於分頁。 |
|
先前的結果網址
|
previouslink | uri |
上一組結果的 URL。 用於分頁。 |
|
記錄總數
|
total | integer |
指定篩選器的記錄總數 |
|
記錄
|
value | array of v1.RecordApi.RecordRead |
針對給定篩選器傳回的記錄記錄清單。 |
列出記錄的電子郵件地址
傳回記錄的電子郵件地址清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
記錄識別碼
|
record_id | True | integer |
系統產生的 ID 以唯一識別記錄。 |
|
是主要的嗎？
|
is_primary | boolean |
搜尋主要電子郵件。 |
|
|
Fields
|
fields | array |
回應中以逗號分隔的欄位清單。 |
|
|
頁面大小
|
page_size | integer |
代表要傳回的記錄數目。 預設值為 10。 最大值為 50。 |
|
|
頁碼
|
page | integer |
表示頁碼 （偏移）。 用於分頁。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
下一個結果網址
|
nextlink | uri |
下一頁結果集的URL。 用於分頁。 |
|
先前的結果網址
|
previouslink | uri |
上一組結果的 URL。 用於分頁。 |
|
電子郵件地址總數
|
total | integer |
指定篩選器的電子郵件地址總數 |
|
電子郵件地址
|
value | array of v1.RecordApi.EmailAddressRead |
針對指定篩選器傳回之記錄的電子郵件地址清單。 結果是分頁的。 |
刪除記錄的電子郵件地址
刪除記錄的電子郵件地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
記錄識別碼
|
record_id | True | integer |
系統產生的 ID 以唯一識別記錄。 |
|
ID
|
email_id | True | integer |
系統產生的 ID，以唯一識別記錄的電子郵件地址。 |
取得活動
傳回事件的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
id | True | integer |
系統產生的 ID 以唯一識別事件。 |
|
Fields
|
fields | array |
回應中以逗號分隔的欄位清單。 |
傳回
Event
取得記錄
傳回記錄的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
記錄識別碼
|
id | True | integer |
系統產生的 ID 以唯一識別記錄。 |
|
Fields
|
fields | array |
回應中以逗號分隔的欄位清單。 |
傳回
資料列
取得記錄的電子郵件地址
傳回記錄電子郵件地址的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
記錄識別碼
|
record_id | True | integer |
系統產生的 ID 以唯一識別記錄。 |
|
ID
|
email_id | True | integer |
系統產生的 ID，以唯一識別記錄的電子郵件地址。 |
傳回
電子郵件地址
建立事件
建立新事件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Description
|
description | string |
事件的描述 |
|
|
結束時間
|
end_datetime | string |
活動結束時間 |
|
|
外部資料庫 ID
|
external_database_id | string |
外部資料庫為記錄指派的唯一 ID 的系統。 例如，Raiser Edge NXT 的系統記錄 ID、Salesforce 的聯絡人 ID |
|
|
外部註冊網址
|
external_registration_url | string |
外部網站上活動的註冊網址 |
|
|
名稱
|
name | True | string |
事件的名稱 |
|
開始時間
|
start_datetime | string |
活動開始時間 |
|
|
Timezone
|
timezone | string |
活動時區 |
|
|
名稱
|
display_name | string |
舉辦地點的城市、州、國家 |
傳回
Event
建立基金
建立新基金。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
外部資料庫 ID
|
external_database_id | string |
由外部資料庫為基金指派唯一 ID 的系統。 例如，Raiser Edge NXT 的系統記錄 ID、Salesforce 的物件 ID |
|
|
違約資金嗎？
|
is_default | boolean |
表示如果捐贈頁面上沒有定義其他基金，則將所有分割與該基金相關聯。 |
|
|
其他基金嗎？
|
is_other_fund | boolean |
表示該基金的捐贈者已指定自訂基金名稱。 |
|
|
基金名稱
|
name | True | string |
基金名稱 |
傳回
與贈與分割相關的基金。
建立接觸點
將新的自訂接觸點傳送至 Almabase。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
程式
|
touchpoint_program | True | integer |
依接觸點程式篩選型別。 |
|
Email
|
用於活動的電子郵件ID。 |
|||
|
ID
|
id | integer |
系統產生的 ID 以唯一識別記錄。 |
|
|
記錄於
|
recorded_at | True | date-time |
活動的時間戳記。 |
|
類型
|
id | True | integer |
傳回
Touchpoint body，以建立新的接觸點
建立記錄
建立新記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
1號線
|
line1 | True | string |
地址的第 1 行 |
|
第 2 行
|
line2 | string |
地址的第 2 行 |
|
|
名稱
|
name | string |
所在城市、州、國家/地區 |
|
|
隱私權
|
privacy | string |
隱私權 |
|
|
類型
|
type | True | string |
號碼類型 |
|
郵遞區號
|
zip_code | string |
地址的郵遞區號 |
|
|
出生日期
|
date_of_birth | string |
出生日期。 |
|
|
已故
|
deceased | boolean |
已故。 |
|
|
Address
|
address |
電子郵件位址 |
||
|
用於登錄？
|
is_login_email | boolean |
指出是否允許使用者使用此電子郵件地址登入平台。 |
|
|
是主要的嗎？
|
is_primary | boolean |
主要電子郵件用於發送系統觸發的自動電子郵件。 它也用於將大量電子郵件傳送至設定檔。 必須只將一封電子郵件設定為主要電子郵件。 |
|
|
來源
|
source | string |
來源會指出如何將電子郵件新增至資料庫。 |
|
|
地位
|
status | string |
電子郵件地址的狀態 |
|
|
類型
|
type | string |
電子郵件類型 |
|
|
外部資料庫 ID
|
external_database_id | string |
外部資料庫為記錄指派的唯一 ID 的系統。 例如，Raiser Edge NXT 的系統記錄 ID、Salesforce 的聯絡人 ID |
|
|
外部資料庫查閱標識碼
|
external_database_lookup_id | string |
外部資料庫中記錄的自訂使用者定義查閱 ID。 例如選民 ID |
|
|
名字
|
first_name | True | string |
記錄的名字。 |
|
姓氏
|
last_name | True | string |
記錄的姓氏。 |
|
中間名
|
middle_name | string |
記錄的中間名。 |
|
|
Number
|
number | True | string |
Number |
|
隱私權
|
privacy | string |
隱私權 |
|
|
類型
|
type | True | string |
號碼類型 |
傳回
資料列
建立記錄的電子郵件地址
為記錄建立新的電子郵件地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
記錄識別碼
|
record_id | True | integer |
系統產生的 ID 以唯一識別記錄。 |
|
Address
|
address |
電子郵件位址 |
||
|
用於登錄？
|
is_login_email | boolean |
指出是否允許使用者使用此電子郵件地址登入平台。 |
|
|
是主要的嗎？
|
is_primary | boolean |
主要電子郵件用於發送系統觸發的自動電子郵件。 它也用於將大量電子郵件傳送至設定檔。 必須只將一封電子郵件設定為主要電子郵件。 |
|
|
來源
|
source | string |
來源會指出如何將電子郵件新增至資料庫。 |
|
|
地位
|
status | string |
電子郵件地址的狀態 |
|
|
類型
|
type | string |
電子郵件類型 |
傳回
電子郵件地址
提交表單
傳回表單提交的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Form
|
form_id | True | integer |
系統產生的 ID 以唯一識別表單。 |
|
回應標識碼
|
entry_id | True | string |
系統產生的 ID 以唯一識別表單提交。 |
傳回
提交表單
為表單建立新的表單提交
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Form
|
form_id | True | integer |
系統產生的 ID 以唯一識別表單。 |
|
body
|
body | dynamic |
建立新的表單提交 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
回應標識碼
|
id | integer |
系統產生的 ID 以唯一識別表單提交。 |
新增連絡人
將連絡人新增至事件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
id | True | integer |
系統產生的 ID 以唯一識別事件。 |
|
Email
|
聯絡人的電子郵件 |
|||
|
名稱
|
name | string |
聯絡人姓名 |
|
|
電話號碼
|
phone_number | string |
聯絡人的電話號碼 |
傳回
活動聯絡人
更新基金
更新基金。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
基金編號
|
id | True | integer |
系統產生的 ID 以唯一識別基金。 |
|
外部資料庫 ID
|
external_database_id | string |
由外部資料庫為基金指派唯一 ID 的系統。 例如，Raiser Edge NXT 的系統記錄 ID、Salesforce 的物件 ID |
|
|
違約資金嗎？
|
is_default | boolean |
表示如果捐贈頁面上沒有定義其他基金，則將所有分割與該基金相關聯。 |
|
|
其他基金嗎？
|
is_other_fund | boolean |
表示該基金的捐贈者已指定自訂基金名稱。 |
|
|
基金名稱
|
name | True | string |
基金名稱 |
傳回
與贈與分割相關的基金。
更新活動
更新事件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
id | True | integer |
系統產生的 ID 以唯一識別事件。 |
|
Description
|
description | string |
事件的描述 |
|
|
結束時間
|
end_datetime | string |
活動結束時間 |
|
|
外部資料庫 ID
|
external_database_id | string |
外部資料庫為記錄指派的唯一 ID 的系統。 例如，Raiser Edge NXT 的系統記錄 ID、Salesforce 的聯絡人 ID |
|
|
外部註冊網址
|
external_registration_url | string |
外部網站上活動的註冊網址 |
|
|
名稱
|
name | string |
事件的名稱 |
|
|
開始時間
|
start_datetime | string |
活動開始時間 |
|
|
Timezone
|
timezone | string |
活動時區 |
|
|
名稱
|
display_name | string |
舉辦地點的城市、州、國家 |
傳回
Event
更新禮物
更新禮物
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
禮品 ID
|
id | True | integer |
系統產生的 ID 以唯一識別禮物。 |
|
批號
|
batch_number | string |
禮品的批號。 |
|
|
捐贈者地址：1號線
|
donor_address_line1 | string |
捐贈者用於禮物的地址行 1。 |
|
|
捐贈者地址：第 2 行
|
donor_address_line2 | string |
捐贈者用於禮物的地址行 2。 |
|
|
名稱：城市、州、國家
|
name | string |
捐贈者的城市。 格式：城市名稱、簡短州名、簡短國家名稱 |
|
|
捐贈者姓名
|
donor_name | string |
捐贈者的全名。 |
|
|
捐贈者電話號碼
|
donor_phone_number | string |
捐贈者用於禮物的電話號碼。 |
|
|
捐贈者地址：郵政編碼
|
donor_zip_code | string |
捐贈者用於禮物的地址的郵政編碼。 |
|
|
排行榜隱藏了嗎？
|
exclude_from_leaderboard | boolean |
排行榜隱藏了嗎？ |
|
|
外部資料庫 ID
|
external_database_id | string |
外部資料庫為禮物指派唯一 ID 的系統。 |
|
|
致敬訊息
|
honor_message | string |
致敬禮物的訊息。 |
|
|
貢品前綴
|
honor_prefix | string |
禮物致敬的前綴。 可用選項包括in_honor_of、in_memory_of in_support_of |
|
|
是匿名的嗎？
|
is_anonymous | boolean |
表示捐贈者希望對其他捐贈者匿名接受此禮物。 |
|
|
備註
|
note | string |
註釋文字。 |
|
|
其他基金名稱
|
other_fund_name | string |
當捐贈者選取標示為is_other_fund的基金時，他們會新增自訂基金名稱來歸屬禮物。 |
|
|
捐贈頁面
|
id | integer |
系統生成的 ID 以唯一標識捐贈頁面。 |
|
|
ID
|
id | integer |
系統產生的 ID 以唯一識別記錄。 |
|
|
總數
|
amount | True | string |
禮物分割的金額。 |
|
款
|
id | True | integer |
系統產生的 ID 以唯一識別基金。 |
傳回
禮物
更新記錄
更新記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
記錄識別碼
|
id | True | integer |
系統產生的 ID 以唯一識別記錄。 |
|
外部資料庫 ID
|
external_database_id | string |
外部資料庫為記錄指派的唯一 ID 的系統。 例如，Raiser Edge NXT 的系統記錄 ID、Salesforce 的聯絡人 ID |
|
|
外部資料庫查閱標識碼
|
external_database_lookup_id | string |
外部資料庫中記錄的自訂使用者定義查閱 ID。 例如選民 ID |
|
|
名字
|
first_name | string |
記錄的名字。 |
|
|
姓氏
|
last_name | string |
記錄的姓氏。 |
傳回
資料列
更新記錄的電子郵件地址
更新記錄的欄位電子郵件地址
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
記錄識別碼
|
record_id | True | integer |
系統產生的 ID 以唯一識別記錄。 |
|
電子郵件地址 ID
|
email_id | True | integer |
系統產生的 ID，以唯一識別記錄的電子郵件地址。 |
|
用於登錄？
|
is_login_email | boolean |
指出是否允許使用者使用此電子郵件地址登入平台。 |
|
|
是主要的嗎？
|
is_primary | boolean |
主要電子郵件用於發送系統觸發的自動電子郵件。 它也用於將大量電子郵件傳送至設定檔。 必須只將一封電子郵件設定為主要電子郵件。 |
|
|
地位
|
status | string |
電子郵件地址的狀態 |
|
|
類型
|
type | string |
電子郵件類型 |
傳回
電子郵件地址
更新連絡人
更新事件的連絡人。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
id | True | integer |
系統產生的 ID 以唯一識別事件。 |
|
活動連絡人識別碼
|
person_id | True | integer |
系統產生的 ID，以唯一識別事件中的聯絡人。 |
|
Email
|
聯絡人的電子郵件 |
|||
|
名稱
|
name | string |
聯絡人姓名 |
|
|
電話號碼
|
phone_number | string |
聯絡人的電話號碼 |
傳回
活動聯絡人
獲取捐贈頁面
傳回有關捐贈頁面的資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
提供頁面 ID
|
id | True | integer |
系統生成的 ID 以唯一標識捐贈頁面。 |
|
Fields
|
fields | array |
回應中以逗號分隔的欄位清單。 |
傳回
捐贈頁面
獲得基金
傳回基金的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
基金編號
|
id | True | integer |
系統產生的 ID 以唯一識別基金。 |
|
Fields
|
fields | array |
回應中以逗號分隔的欄位清單。 |
傳回
與贈與分割相關的基金。
獲得禮物
傳回有關禮物的資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
禮品 ID
|
id | True | integer |
系統產生的 ID 以唯一識別禮物。 |
|
Fields
|
fields | array |
回應中以逗號分隔的欄位清單。 |
傳回
禮物
製作禮物
創造一份新禮物。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
贈品金額
|
amount | True | string |
贈送金額以小數點後兩位。 |
|
批號
|
batch_number | string |
禮品的批號。 |
|
|
贈送日期
|
completed_at | True | date-time |
禮物狀態標示為已完成的日期。 |
|
貨幣
|
currency | True | integer |
捐贈者用於禮物的貨幣。 |
|
捐贈者地址：1號線
|
donor_address_line1 | string |
捐贈者用於禮物的地址行 1。 |
|
|
捐贈者地址：第 2 行
|
donor_address_line2 | string |
捐贈者用於禮物的地址行 2。 |
|
|
名稱：城市、州、國家
|
name | string |
捐贈者的城市。 格式：城市名稱、簡短州名、簡短國家名稱 |
|
|
捐贈者電子郵件
|
donor_email | True |
捐贈者用於禮物的電子郵件 ID。 |
|
|
捐贈者姓名
|
donor_name | True | string |
捐贈者的全名。 |
|
捐贈者電話號碼
|
donor_phone_number | string |
捐贈者用於禮物的電話號碼。 |
|
|
捐贈者地址：郵政編碼
|
donor_zip_code | string |
捐贈者用於禮物的地址的郵政編碼。 |
|
|
排行榜隱藏了嗎？
|
exclude_from_leaderboard | boolean |
排行榜隱藏了嗎？ |
|
|
外部資料庫 ID
|
external_database_id | string |
外部資料庫為禮物指派唯一 ID 的系統。 |
|
|
致敬訊息
|
honor_message | string |
致敬禮物的訊息。 |
|
|
貢品前綴
|
honor_prefix | string |
禮物致敬的前綴。 可用選項包括in_honor_of、in_memory_of in_support_of |
|
|
是匿名的嗎？
|
is_anonymous | boolean |
表示捐贈者希望對其他捐贈者匿名接受此禮物。 |
|
|
付款方式
|
mode | True | string |
付款方式，在線或離線。 |
|
備註
|
note | string |
註釋文字。 |
|
|
其他基金名稱
|
other_fund_name | string |
當捐贈者選取標示為is_other_fund的基金時，他們會新增自訂基金名稱來歸屬禮物。 |
|
|
捐贈頁面
|
id | integer |
系統生成的 ID 以唯一標識捐贈頁面。 |
|
|
ID
|
id | integer |
系統產生的 ID 以唯一識別記錄。 |
|
|
總數
|
amount | True | string |
禮物分割的金額。 |
|
款
|
id | True | integer |
系統產生的 ID 以唯一識別基金。 |
|
地位
|
status | True | string |
禮物的狀態。 |
傳回
禮物
觸發程序
| 在 Almabase 上建立或更新記錄時 |
在 Almabase 上建立新記錄或更新現有記錄時觸發。 |
| 在記錄上建立、更新或刪除電子郵件時 |
在記錄上建立新電子郵件，或從記錄中更新或刪除現有電子郵件時觸發。 |
| 提交表單或更新現有表單提交時 |
在提交表單或更新現有表單提交時觸發。 |
| 當新禮品成功或網上禮品支付失敗時 |
當捐贈者在捐贈頁面上成功記錄新禮物或禮物付款失敗時觸發。 |
在 Almabase 上建立或更新記錄時
在 Almabase 上建立新記錄或更新現有記錄時觸發。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
When
|
events | True | string |
要觸發流程的事件清單。 |
傳回
在記錄上建立、更新或刪除電子郵件時
在記錄上建立新電子郵件，或從記錄中更新或刪除現有電子郵件時觸發。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
When
|
events | True | string |
要觸發流程的事件清單。 |
傳回
提交表單或更新現有表單提交時
在提交表單或更新現有表單提交時觸發。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
When
|
events | True | string |
要觸發流程的事件清單。 |
|
Form
|
object_id | True | integer |
系統產生的 ID 以唯一識別表單。 |
傳回
當新禮品成功或網上禮品支付失敗時
當捐贈者在捐贈頁面上成功記錄新禮物或禮物付款失敗時觸發。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
When
|
events | True | string |
要觸發流程的事件清單。 |
|
捐贈頁面
|
object_id | integer |
系統生成的 ID 以唯一標識捐贈頁面。 |
傳回
定義
v1 的FormApi.FormRead
Form
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
系統產生的 ID 以唯一識別表單。 |
|
表單名稱
|
title | string |
表單的名稱 |
v1 的GivingApi.GiftWebhookRecord讀取
錄製
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
外部資料庫 ID
|
external_database_id | string |
外部資料庫為記錄指派的唯一 ID 的系統。 例如，Raiser Edge NXT 的系統記錄 ID、Salesforce 的聯絡人 ID |
|
名字
|
first_name | string |
對應記錄的名字 |
|
ID
|
id | integer |
系統產生的 ID 以唯一識別記錄。 |
|
捐贈者是否在 Almabase 上註冊？
|
is_registered | boolean |
指出映射記錄或捐贈者是否在 Almabase 上註冊 |
|
姓氏
|
last_name | string |
對應記錄的姓氏 |
v1 的GivingApi.GiftWebhook回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
總數
|
data.amount | string |
贈送金額以小數點後兩位。 |
|
Date
|
data.completed_at | date-time |
禮物狀態標示為已完成的日期。 |
|
捐贈者電子郵件
|
data.email |
捐贈者用於禮物的電子郵件 ID。 |
|
|
外部資料庫 ID
|
data.external_database_id | string |
外部資料庫為禮物指派唯一 ID 的系統。 |
|
ID
|
data.id | integer |
系統產生的 ID 以唯一識別禮物。 |
|
是新電子郵件嗎？
|
data.is_email_new | boolean |
指出捐贈者提供的電子郵件是否已存在於 Almabase 記錄中。 |
|
結構描述
|
data.mapped_profile.schema | v1.GivingApi.GiftWebhookRecordRead |
錄製 |
|
Mode
|
data.mode | string |
禮物的模式。 |
|
捐贈者姓名
|
data.name | string |
捐贈者的全名。 |
|
ID
|
data.page.id | integer |
系統生成的 ID 以唯一標識捐贈頁面。 |
|
提供頁面名稱
|
data.page.name | string |
相關捐贈頁面的名稱 |
|
地位
|
data.status | string |
禮物的狀態。 |
|
觸發的事件
|
time | string |
活動時間。 |
|
事件類型
|
type | string |
事件類型。 |
v1 的GivingApi.Location讀取
捐贈者用於禮物的城市。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
城市
|
city | string |
捐贈者的城市 |
|
城市簡稱
|
city_short_name | string |
城市的簡短表示，例如舊金山 |
|
緯度
|
coordinates.latitude | string |
位置的緯度 |
|
經度
|
coordinates.longitude | string |
位置的經度 |
|
國家
|
country | string |
捐贈者的國家 |
|
國家簡稱
|
country_short_name | string |
國家/地區的簡短代表，例如美國 |
|
Google 地點 ID
|
gpid | string |
從 Google 取得的地點 ID |
|
城市、州、國家
|
name | string |
捐贈者的城市。 格式：城市名稱、簡短州名、簡短國家名稱 |
|
State
|
state | string |
捐贈者的狀態 |
|
狀態簡稱
|
state_short_name | string |
州的簡短代表，例如 CA |
v1 的GivingApi.FormField讀取
表單欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
display_value | string |
回應者輸入的格式化值。 例如上傳檔案的名稱。 |
|
問題/表單欄位名稱
|
label | string |
表單上的問題/表單欄位名稱 |
v1 的GivingApi.基金閱讀
與贈與分割相關的基金。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
外部資料庫 ID
|
external_database_id | string |
由外部資料庫為基金指派唯一 ID 的系統。 例如，Raiser Edge NXT 的系統記錄 ID、Salesforce 的物件 ID |
|
ID
|
id | integer |
系統產生的 ID 以唯一識別基金。 |
|
違約資金嗎？
|
is_default | boolean |
表示如果捐贈頁面上沒有定義其他基金，則將所有分割與該基金相關聯。 |
|
其他基金嗎？
|
is_other_fund | boolean |
表示該基金的捐贈者已指定自訂基金名稱。 |
|
名稱
|
name | string |
基金名稱 |
v1 的GivingApi.GiftRead
禮物
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
贈品金額
|
amount | string |
贈送金額以小數點後兩位。 |
|
批號
|
batch_number | string |
禮品的批號。 |
|
贈送日期
|
completed_at | date-time |
禮物狀態標示為已完成的日期。 |
|
貨幣
|
currency | integer |
捐贈者用於禮物的貨幣。 |
|
Device
|
device | string |
識別用於製作禮物的設備，例如個人電腦、手機或平板電腦。 |
|
捐贈者地址：1號線
|
donor_address_line1 | string |
捐贈者用於禮物的地址行 1。 |
|
捐贈者地址：第 2 行
|
donor_address_line2 | string |
捐贈者用於禮物的地址行 2。 |
|
捐贈者地址： 地點
|
donor_city_place | v1.GivingApi.LocationRead |
捐贈者用於禮物的城市。 |
|
捐贈者電子郵件
|
donor_email |
捐贈者用於禮物的電子郵件 ID。 |
|
|
捐贈者姓名
|
donor_name | string |
捐贈者的全名。 |
|
捐贈者電話號碼
|
donor_phone_number | string |
捐贈者用於禮物的電話號碼。 |
|
捐贈者地址：郵政編碼
|
donor_zip_code | string |
捐贈者用於禮物的地址的郵政編碼。 |
|
排行榜隱藏了嗎？
|
exclude_from_leaderboard | boolean |
排行榜隱藏了嗎？ |
|
外部資料庫 ID
|
external_database_id | string |
外部資料庫為禮物指派唯一 ID 的系統。 |
|
致敬訊息
|
honor_message | string |
致敬禮物的訊息。 |
|
貢品前綴
|
honor_prefix | string |
禮物致敬的前綴。 可用選項包括in_honor_of、in_memory_of in_support_of |
|
ID
|
id | integer |
系統產生的 ID 以唯一識別禮物。 |
|
影響者
|
influencer | v1.GivingApi.InfluencerRead |
公用共用連結和私人儀表板連結 |
|
是匿名的嗎？
|
is_anonymous | boolean |
表示捐贈者希望對其他捐贈者匿名接受此禮物。 |
|
捐贈者是否支付了支付網關費用？
|
is_donor_covered_charges | boolean |
表明捐贈者在贈送此禮物時是否選擇支付支付網關費用？ |
|
電子郵件是否新增至 Almabase 上的記錄？
|
is_email_added_to_profile | boolean |
指出捐贈者提供的電子郵件是否已新增至 Almabase 記錄 （無論is_email_new狀態為何） |
|
是新電子郵件嗎？
|
is_email_new | boolean |
指出捐贈者提供的電子郵件是否已存在於 Almabase 記錄中。 |
|
映射到 Almabase 上的記錄是否被忽略？
|
is_profile_mapping_ignored | boolean |
指出是否應該忽略記錄對應。 |
|
付款方式
|
mode | string |
付款方式，在線或離線。 |
|
備註
|
note | string |
註釋文字。 |
|
其他基金名稱
|
other_fund_name | string |
當捐贈者選取標示為is_other_fund的基金時，他們會新增自訂基金名稱來歸屬禮物。 |
|
捐贈頁面
|
page | v1.GivingApi.GivingPageAssociatedWithGift |
與禮物相關聯的捐贈頁面。 |
|
Fields
|
post_payment_form_entry.fields | array of v1.GivingApi.FormFieldRead | |
|
回應標識碼
|
post_payment_form_entry.id | integer |
系統產生的 ID 以唯一識別表單提交。 |
|
Fields
|
pre_payment_form_entry.fields | array of v1.GivingApi.FormFieldRead | |
|
回應標識碼
|
pre_payment_form_entry.id | integer |
系統產生的 ID 以唯一識別表單提交。 |
|
對應記錄
|
profile | v1.GivingApi.RecordRead |
Almabase 上的映射記錄 |
|
推薦連結
|
referrer_link | string |
網站鏈接用於確定捐贈者訪問方式的來源。 例如，捐贈者訪問了 Facebook、Google 等的捐贈活動。 |
|
退款金額
|
refund_amount | string |
退還給捐贈者的金額。 如果全額退款，禮物的狀態將被退還，而不是完成。 |
|
分裂
|
splits | array of v1.GivingApi.GiftSplitRead |
與禮物相關的分割。 |
|
地位
|
status | string |
禮物的狀態。 |
|
網上交易
|
transaction | v1.GivingApi.TransactionRead |
與禮品相關的線上付款交易。 |
|
UTM 活動
|
utm_campaign | string |
用於關鍵字分析。 utm_campaign確定特定的產品促銷或策略活動。 例如annual_fund_2020 |
|
UTM 中等
|
utm_medium | string |
utm_medium識別媒介，例如電子郵件或每次點擊費用。 例如每次點擊費用 |
|
UTM 來源
|
utm_source | string |
utm_source識別搜尋引擎、電子報名稱或其他來源。 例如谷歌 |
v1 的GivingApi.GiftSplit閱讀
禮品分割
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
總數
|
amount | string |
禮物分割的金額。 |
|
款
|
fund | v1.GivingApi.FundRead |
與贈與分割相關的基金。 |
|
ID
|
id | integer |
系統產生的 ID 以唯一識別禮物分割。 |
v1 的GivingApi.GivingPageAssociatedWithGift
與禮物相關聯的捐贈頁面。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
系統生成的 ID 以唯一標識捐贈頁面。 |
|
名稱
|
name | string |
相關聯的捐贈頁面名稱。 |
v1 的GivingApi.GivingPageRead
捐贈頁面
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
系統生成的 ID 以唯一標識捐贈頁面。 |
|
名稱
|
name | string |
捐贈頁面名稱 |
v1 的GivingApi.Influencer閱讀
公用共用連結和私人儀表板連結
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
私人影響者儀表板鏈接
|
dashboard_url | uri |
捐贈者的私人儀表板，用於監控受其影響的頁面訪問次數和禮物數量 |
|
公開共用連結
|
page_share_url | uri |
捐贈頁面/捐贈者活動的公共鏈接，以跟踪對捐贈頁面訪問和禮物的影響。 |
v1 的GivingApi.PaymentAccount閱讀
與交易關聯的付款帳戶，例如 BBMS、Stripe、PayPal 等。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
系統產生的 ID 以唯一識別付款帳戶。 |
|
名稱
|
name | string |
付款帳戶的名稱。 |
|
Gateway
|
type | string |
付款閘道的名稱。 |
v1 的GivingApi.RecordRead
Almabase 上的映射記錄
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
外部資料庫 ID
|
external_database_id | string |
外部資料庫為記錄指派的唯一 ID 的系統。 例如，Raiser Edge NXT 的系統記錄 ID、Salesforce 的聯絡人 ID |
|
名字
|
first_name | string |
對應記錄的名字 |
|
全名
|
formatted_name | string |
對映記錄的完整名稱 |
|
ID
|
id | integer |
系統產生的 ID 以唯一識別記錄。 |
|
捐贈者是否在 Almabase 上註冊？
|
is_registered | boolean |
指出映射記錄或捐贈者是否在 Almabase 上註冊 |
|
姓氏
|
last_name | string |
對應記錄的姓氏 |
|
圖片網址
|
present_picture | uri |
記錄圖片的網址 |
|
Link
|
profile_url | uri |
Almabase 上的記錄鏈接 |
v1 的GivingApi.TransactionRead
與禮品相關的線上付款交易。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
付款帳戶
|
account | v1.GivingApi.PaymentAccountRead |
與交易關聯的付款帳戶，例如 BBMS、Stripe、PayPal 等。 |
|
建立時間
|
created_at | date-time |
建立此交易的時間。 |
|
失敗原因
|
failure_reason | string |
付款閘道傳回的交易失敗原因。 |
|
ID
|
id | uuid |
系統產生的 ID 以唯一識別交易。 |
|
地位
|
status | integer |
交易狀態。 - 1 （未處理） - 2 （成功） - 3 （失敗） - 4 （擱置中） - 5 （錯誤）注意：這些狀態與付款網關的交易狀態相關聯 |
|
付款閘道參考 ID
|
transaction_id | string |
付款閘道產生的唯一 ID，用於識別交易。 例如 Blackbaud 商家服務 （BBMS） 交易 ID，或 Stripe Charge ID、PayPal 交易 ID |
v1 的AlmasightsApi.RecordAddOrEdit
在 Almabase 上錄製。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
系統產生的 ID 以唯一識別記錄。 |
v1 的AlmasightsApi.TouchpointCustomObjectAdd
Touchpoint body，以建立新的接觸點
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Email
|
用於活動的電子郵件ID。 |
||
|
錄製
|
mapped_profile | v1.AlmasightsApi.RecordAddOrEdit |
在 Almabase 上錄製。 |
|
記錄於
|
recorded_at | date-time |
活動的時間戳記。 |
|
類型
|
touchpoint_type.id | integer |
v1 的RecordApi.Location讀取
地址位置
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
城市
|
city | string |
位置的城市名稱 |
|
國家
|
country | string |
位置的國家/地區名稱 |
|
緯度
|
latitude | double |
位置的緯度 |
|
經度
|
longitude | double |
位置的經度 |
|
State
|
state | string |
位置的州名稱 |
v1 的RecordApi.AddressRead
Address
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
第 1 行
|
line1 | string |
地址的第 1 行 |
|
第 2 行
|
line2 | string |
地址的第 2 行 |
|
結構描述
|
location.schema | v1.RecordApi.LocationRead |
地址位置 |
|
郵遞區號
|
zipcode | string |
地址的郵遞區號 |
v1 的RecordApi.EmailWebhookRecordRead
錄製
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
外部資料庫 ID
|
external_database_id | string |
外部資料庫為記錄指派的唯一 ID 的系統。 例如，Raiser Edge NXT 的系統記錄 ID、Salesforce 的聯絡人 ID |
|
名字
|
first_name | string |
對應記錄的名字 |
|
ID
|
id | integer |
系統產生的 ID 以唯一識別記錄。 |
|
記錄是否在 Almabase 上註冊？
|
is_registered | boolean |
指出對映記錄是否在 Almabase 上註冊 |
|
姓氏
|
last_name | string |
對應記錄的姓氏 |
v1 的RecordApi.EmailWebhook回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
電子郵件地址
|
data.address |
電子郵件地址。 |
|
|
ID
|
data.id | integer |
系統產生的 ID 以唯一識別電子郵件。 |
|
是主要的
|
data.is_primary | boolean |
指出電子郵件是否為主要電子郵件。 |
|
結構描述
|
data.profile.schema | v1.RecordApi.EmailWebhookRecordRead |
錄製 |
|
電子郵件類型
|
data.type | string |
電子郵件地址的型別（主要、個人、工作等）。 |
|
觸發的事件
|
time | string |
活動時間。 |
|
事件類型
|
type | string |
事件類型。 |
v1 的RecordApi.RecordWebhook回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Affiliations
|
data.affiliations | array of string | |
|
上課年份
|
data.class_year | string |
記錄的班級 |
|
電子郵件地址
|
data.email |
電子郵件地址。 |
|
|
外部資料庫 ID
|
data.external_database_id | string |
外部資料庫為記錄指派的唯一 ID 的系統。 例如，Raiser Edge NXT 的系統記錄 ID、Salesforce 的聯絡人 ID |
|
名字
|
data.first_name | string |
對應記錄的名字 |
|
結構描述
|
data.home_address.schema | v1.RecordApi.AddressRead |
Address |
|
ID
|
data.id | integer |
系統產生的 ID 以唯一識別記錄。 |
|
姓氏
|
data.last_name | string |
對應記錄的姓氏 |
|
會籍有效期
|
data.membership_expiry_date | date-time |
記錄成員資格的到期日 |
|
成員資格類型名稱
|
data.membership_type_name | string |
記錄成員資格類型的名稱 |
|
手機號碼
|
data.mobile_number | string |
記錄的手機號碼 |
|
結構描述
|
data.office_address.schema | v1.RecordApi.AddressRead |
Address |
|
辦公室電話號碼
|
data.office_phone_number | string |
記錄的辦公室電話號碼 |
|
居住電話號碼
|
data.residence_phone_number | string |
記錄的居住電話號碼 |
|
觸發的事件
|
time | string |
活動時間。 |
|
事件類型
|
type | string |
事件類型。 |
v1 的RecordApi.EmailAddressRead
電子郵件地址
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Address
|
address |
電子郵件位址 |
|
|
ID
|
id | integer |
系統產生的 ID，以唯一識別記錄的電子郵件地址。 |
|
訂婚了嗎？
|
is_engaged | boolean |
指出是否按一下或開啟大量電子郵件，或使用者回覆一對一電子郵件 |
|
用於登錄？
|
is_login_email | boolean |
指出是否允許使用者使用此電子郵件地址登入平台。 |
|
是主要的嗎？
|
is_primary | boolean |
主要電子郵件用於發送系統觸發的自動電子郵件。 它也用於將大量電子郵件傳送到記錄。 必須只將一封電子郵件設定為主要電子郵件。 |
|
是否由用戶驗證？
|
is_verified | boolean |
指出使用者是否已驗證他們擁有電子郵件。 |
|
來源
|
source | string |
來源會指出如何將電子郵件新增至資料庫。 |
|
狀態
|
status | string | |
|
類型
|
type | string |
電子郵件類型 |
v1 的RecordApi.RecordRead
資料列
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
電子郵件地址
|
email_addresses | array of v1.RecordApi.EmailAddressRead |
設定檔的電子郵件地址清單 |
|
外部資料庫 ID
|
external_database_id | string |
外部資料庫為記錄指派的唯一 ID 的系統。 例如，Raiser Edge NXT 的系統記錄 ID、Salesforce 的聯絡人 ID |
|
名字
|
first_name | string |
記錄的名字。 |
|
全名
|
formatted_name | string |
記錄的全名。 |
|
ID
|
id | integer |
系統產生的 ID 以唯一識別記錄。 |
|
在 Almabase 上註冊了嗎？
|
is_registered | boolean |
指出記錄或捐贈者是否在 Almabase 上註冊 |
|
姓氏
|
last_name | string |
記錄的姓氏。 |
|
圖片網址
|
present_picture | uri |
記錄圖片的網址 |
|
Link
|
record_url | uri |
Almabase 上的記錄鏈接 |
v1 的EventApi.ContactPersonRead
活動聯絡人
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Email
|
聯絡人的電子郵件 |
||
|
ID
|
id | integer |
系統產生的 ID 以唯一識別聯絡人。 |
|
名稱
|
name | string |
聯絡人姓名 |
|
電話號碼
|
phone_number | string |
聯絡人的電話號碼 |
v1 的EventApi.EventRead
Event
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Description
|
description | string |
事件的描述 |
|
結束時間
|
end_datetime | string |
活動結束時間 |
|
外部資料庫 ID
|
external_database_id | string |
外部資料庫為記錄指派的唯一 ID 的系統。 例如，Raiser Edge NXT 的系統記錄 ID、Salesforce 的聯絡人 ID |
|
外部註冊網址
|
external_registration_url | string |
外部網站上活動的註冊網址 |
|
ID
|
id | integer |
系統產生的 ID 以唯一識別事件。 |
|
名稱
|
name | string |
事件的名稱 |
|
開始時間
|
start_datetime | string |
活動開始時間 |
|
Timezone
|
timezone | string |
活動時區 |