Blackbaud Raisers Edge NXT (プレビュー)

  • リファレンス

Blackbaud Raiser's Edge NXT は、非営利団体と社会貢献コミュニティ全体のために特別に構築された、包括的なクラウドベースの資金調達および寄付者管理ソフトウェア ソリューションです。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Blackbaud サポート
[URL] https://www.blackbaud.com/support
メール skyapi@blackbaud.com
Connector Metadata
発行者 Blackbaud, Inc.
Web サイト https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
プライバシー ポリシー https://www.blackbaud.com/privacy-shield
カテゴリー 販売と CRM、生産性

Raiser's Edge NXT は、非営利団体と社会貢献コミュニティ全体のために特別に構築された、包括的なクラウドベースの資金調達および寄付者管理ソフトウェア ソリューションです。

このコネクタは Blackbaud の SKY API の上に構築されており、次を含む、Raiser's Edge NXT 内で検索されたエンティティの管理に役立つ操作を提供します:

  • スタッフ
  • ギフト
  • アクション​​
  • メモ
  • カスタム フィールド
  • キャンペーン
  • 資金
  • 異議申し立て
  • その他...

詳細については、ドキュメントを参照してください。

前提条件

このコネクタを使用するには、1 つ以上の Blackbaud 環境にアクセスできる Blackbaud ID アカウントが必要です。

さらに、組織の管理者は、このコネクタが Raiser's Edge NXT にアクセスできるようにするために、システム内で管理者レベルのアクションも実行する必要があります。 これらの前提条件の詳細については、初期設定ドキュメントを参照してください。

資格情報の入手方法

組織の管理者は、組織の Raiser's Edge NXT 環境への招待状を送信し、環境内でユーザー アカウントのアクセス許可を構成します。 このコネクタを使用するために追加の資格情報は必要ありません。

既知の問題と制限事項

コネクタはユーザー アカウントのコンテキストで機能するため、環境内のユーザー アクセス許可が適用されます。

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 500 60 秒

アクション

アクション カスタム フィールドを一覧表示する

アクションのカスタム フィールドを一覧表示します。
アクション カスタム フィールドを作成する

新しいアクション カスタム フィールドを作成します。
アクション カスタム フィールドを更新する

アクション カスタム フィールドを更新します。
アクションを一覧表示する

アクションの一覧を返します。
アクション添付資料を一覧表示する

アクションの添付資料を一覧表示します。
アクション添付資料を作成する

新しいアクション添付資料を作成します。
アクション添付資料を更新する

アクション添付資料を更新します。
イベントの参加者オプションを一覧表示する

イベントの参加者オプションを一覧表示します。
イベントの参加者オプションを作成する

イベントの新しい参加者オプションを作成します。
イベントを一覧表示する

イベントの一覧を返します。
イベントを作成する

新しいイベントを作成します。
イベントを取得する

イベントに関する情報を返します。
イベントを更新する

イベントに関する詳細を更新します。
イベント参加者を一覧表示する

イベントの参加者を一覧表示します。
イベント手数料を一覧表示する

イベントの手数料を一覧表示します。
イベント料金を作成する

イベントの新しい料金を作成します。
キャンペーン カスタム フィールドを一覧表示する

キャンペーンのカスタム フィールドを一覧表示します。
キャンペーンのカスタム フィールドを作成する

新しいキャンペーンのカスタム フィールドを作成します。
キャンペーンのカスタム フィールドを更新する

キャンペーンのカスタム フィールドを更新します。
キャンペーンのリストの表示

キャンペーンの一覧を返します。
キャンペーンの添付ファイルを作成する

新しいキャンペーンの添付ファイルを作成します。
キャンペーンを取得する

キャンペーンに関する情報を返します。
キャンペーン添付資料を一覧表示する

キャンペーンの添付資料を一覧表示します。
キャンペーン添付資料を更新する

キャンペーン添付資料を更新します。
ギフト カスタム フィールドを一覧表示する

ギフトのカスタム フィールドを一覧表示します。
ギフト バッチの一覧

ギフト バッチを一覧で表示します。
ギフト バッチを作成する

新しいギフト バッチを作成します。
ギフトのカスタム フィールドを作成する

新しいギフトのカスタム フィールドを作成します。
ギフトのカスタム フィールドを更新する

ギフトのカスタム フィールドを更新します。
ギフトの添付資料を一覧表示する

ギフトの添付資料を一覧表示します。
ギフトを一覧表示する

ギフトの一覧を返します。
ギフトを作成する

新しいギフトを作成します。
ギフトを取得する

ギフトに関する情報を返します。
ギフト受信確認の詳細を更新する

ギフトの受信確認の詳細を更新します。
ギフト添付資料を作成する

新しいギフト添付資料を作成します。
ギフト添付資料を更新する

ギフト添付資料を更新します。
ギフト領収書の詳細を更新する

ギフトの領収書の詳細を更新します。
スタッフ アクションを一覧表示する

スタッフのアクションを一覧表示します。
スタッフ アクションを作成する

新しいスタッフ アクションを作成します。
スタッフ アクションを取得する

スタッフ アクションに関する情報を返します。
スタッフ アクションを更新する

スタッフ アクションを更新します。
スタッフ エイリアスを作成する

新しいスタッフ エイリアスを作成します。
スタッフ エイリアスを更新する

スタッフ エイリアスを更新します。
スタッフ カスタム フィールドを一覧表示する

スタッフのカスタム フィールドを一覧表示します。
スタッフ コードを一覧表示する

スタッフのスタッフ コードを一覧表示します。
スタッフ コードを作成する

新しいスタッフ コードを作成します。
スタッフ コードを削除する

スタッフ コードを削除します。
スタッフ コードを更新する

スタッフ コードを更新します。
スタッフ プロファイル画像を取得する

スタッフの現在のプロファイル画像を返します。
スタッフ プロファイル画像を更新する

スタッフの現在のプロファイル画像を更新します。
スタッフ メモを一覧表示する

スタッフのメモを一覧表示します。
スタッフ メモを作成する

新しいスタッフ メモを作成します。
スタッフ メモを更新する

スタッフ メモを更新します。
スタッフのエイリアスを一覧表示する

スタッフのエイリアスを一覧表示します。
スタッフのオンライン プレゼンスを一覧表示する

スタッフのオンライン プレゼンスを一覧表示します。
スタッフのオンライン プレゼンスを作成する

新しいスタッフのオンライン プレゼンスを作成します。
スタッフのオンライン プレゼンスを更新する

スタッフのオンライン プレゼンスを更新します。
スタッフのカスタム フィールドを作成する

新しいスタッフのカスタム フィールドを作成します。
スタッフのカスタム フィールドを更新する

スタッフのカスタム フィールドを更新します。
スタッフの住所を一覧表示する

スタッフの住所を一覧表示します。
スタッフの同意レコードを一覧表示する

スタッフの同意レコードを一覧表示します。
スタッフの同意レコードを作成する

新しいスタッフの同意レコードを作成します。
スタッフの最初のギフトを取得する

スタッフに対する最初の贈与を返します。
スタッフの最新ギフトを取得する

スタッフの最新ギフトを返します。
スタッフの最高ギフトを取得する

スタッフに対する最大の贈与を返します。
スタッフの生涯寄付を取得します

スタッフの生涯寄付について概要を返します。
スタッフの見込顧客の状態を取得する

スタッフの現在の見込顧客の状態を返します。
スタッフの評価を一覧表示する

スタッフの評価の一覧を返します。
スタッフの評価を作成する

新しいスタッフの評価を作成します。
スタッフの電子メール アドレスを一覧表示する

スタッフの電子メール アドレスを一覧表示します。
スタッフの電子メール アドレスを作成する

新しいスタッフの電子メール アドレスを作成します。
スタッフの電子メール アドレスを更新する

スタッフの電子メール アドレスを更新します。
スタッフの電話番号を一覧表示する

スタッフの電話番号を一覧表示します。
スタッフの電話番号を作成する

新しいスタッフの電話番号を作成します。
スタッフの電話番号を更新する

スタッフの電話番号を更新します。
スタッフを一覧表示する

スタッフの一覧を返します。
スタッフを取得する

スタッフに関する情報を返します。
スタッフを更新する

スタッフを更新します。
スタッフを検索する

指定された検索テキストに基づいてスタッフ検索を実行します。 名、姓、優先名、旧名、エイリアス、電子メール アドレス、電話番号、アドレス、または検索 ID をサポートします。 名と姓、または優先名と姓など、名前の組み合わせは有効ですが、検索は一度に 1 つのパラメーターのみをサポートします。 既定では、検索には条件に類似した結果が含まれます。 たとえば、"Smith" の検索には、"Smyth" やその他の代替スペルの一致が含まれます。 この検索では、* や？などのワイルドカード文字はサポートされていません。 検索結果は 500 レコードに制限されています。
スタッフ住所を作成する

新しいスタッフ住所を作成します。
スタッフ住所を更新する

スタッフ住所を更新します。
スタッフ基金調達者を一覧表示する

スタッフの基金調達者割り当てを一覧表示します。
スタッフ学歴を一覧表示する

スタッフの学歴レコードを一覧表示します。
スタッフ学歴を更新する

スタッフ学歴を更新します。
スタッフ教育を作成する

新しいスタッフ教育を作成します。
スタッフ添付資料を一覧表示する

スタッフの添付資料を一覧表示します。
スタッフ添付資料を作成する

新しいスタッフ添付資料を作成します。
スタッフ添付資料を更新する

スタッフ添付資料を更新します。
スタッフ要請コードを作成する

新しいスタッフ要請コードを作成します。
スタッフ要請コードを更新する

スタッフ要請コードを更新します。
スタッフ関連付けを一覧表示する

スタッフの関連付けを一覧表示します。
スタッフ関連付けを更新する

スタッフの関連付けを更新します。 相互関係が存在する場合は、変更を反映するようにも変更されます。 これには、各レコードに固有であり、各レコードで個別に変更できる "コメント" プロパティへの変更は含まれません。
ドキュメントの場所を作成する

物理的な添付資料で使用するために、新しい一意のドキュメント識別子とアップロード場所を作成します。 応答には、ドキュメントの内容をアップロードする場所および方法についての指示が含まれます。
バッチにギフトを追加する

指定したギフト バッチにギフトを追加します。
パッケージを一覧表示する

パッケージの一覧を返します。
パッケージを取得する

パッケージに関する情報を返します。
レコード セットからリストを作成する

指定したレコード セットをフィルターして新しいリストを作成します。
レコードをリストに追加する

レコード セットを既存のリストに追加します。
個々のスタッフを作成する

新しい個々のスタッフを作成します。
個々の関連付けを作成する

新しい関連付けを作成します。 別のスタッフとの関連付けである場合、そのスタッフに対して相互関係が作成されます。
参加者の寄付を一覧で表示する

参加者の寄付を一覧で表示します。
参加者の寄付を作成する

参加者の新しい寄付を作成します。
参加者の手数料を一覧表示する

参加者の手数料を一覧表示します。
参加者の手数料支払を一覧表示する

参加者の手数料支払を一覧表示します。
参加者の手数料支払を作成する

参加者の新しい手数料支払を作成します。
参加者を作成する

イベントの新しい参加者を作成します。
参加者を取得する

特定のイベント参加者に関する情報を返します。
参加者を更新する

参加者に関する詳細を更新します。
参加者オプションを一覧表示する

参加者の参加者オプションを一覧表示します。
参加者オプションを作成する

参加者の新しい参加者オプションを作成します。
参加者オプションを更新する

参加者オプションに関する詳細を更新します。
参加者費用を作成する

参加者の新しい費用を作成します。
営業案件の添付資料を一覧表示する

営業案件の添付資料を一覧表示します。
営業案件の添付資料を作成する

新しい営業案件の添付資料を作成します。
営業案件の添付資料を更新する

営業案件の添付資料を更新します。
営業案件を一覧表示する

営業案件の一覧を返します。
営業案件を作成する

新しい営業案件を作成します。
営業案件を取得する

営業案件に関する情報を返します。 注: このエンドポイントは、約 10 分の遅延という状態プロパティを返します。
営業案件を更新する

営業案件を更新します。
営業案件カスタム フィールドを一覧表示する

営業案件のカスタム フィールドを一覧表示します。
営業案件カスタム フィールドを作成する

新しい営業案件カスタム フィールドを作成します。
営業案件カスタム フィールドを更新する

営業案件カスタム フィールドを更新します。
基金調達者の割り当てを一覧で表示する

基金調達者の割り当てを一覧で表示します。
基金調達者の割り当てを作成する

新しい基金調達者の割り当てを作成します。
異議申し立てを一覧表示する

異議申し立ての一覧を返します。
異議申し立てを取得する

異議申し立てに関する情報を返します。
異議申し立てカスタム フィールドを一覧表示する

異議申し立てのカスタム フィールドを一覧表示します。
異議申し立てカスタム フィールドを作成する

新しい異議申し立てカスタム フィールドを作成します。
異議申し立てカスタム フィールドを更新する

異議申し立てカスタム フィールドを更新します。
異議申し立て添付資料を一覧表示する

異議申し立ての添付資料を一覧表示します。
異議申し立て添付資料を作成する

新しい異議申し立て添付資料を作成します。
異議申し立て添付資料を更新する

異議申し立て添付資料を更新します。
組織の関連付けを作成する

新しい組織の関連付けを作成します。 別のスタッフとの関連付けである場合、そのスタッフに対して相互関係が作成されます。
組織スタッフを作成する

新しい組織スタッフを作成します。
要請コードを一覧表示する

スタッフの要請コードを一覧表示します。
資金のカスタム フィールドを作成する

新しい資金のカスタム フィールドを作成します。
資金のカスタム フィールドを更新する

資金のカスタム フィールドを更新します。
資金の添付資料を一覧表示する

資金の添付資料を一覧表示します。
資金の添付資料を作成する

新しい資金の添付資料を作成します。
資金の添付資料を更新する

資金の添付資料を更新します。
資金を一覧表示する

資金の一覧を返します。
資金を取得する

資金に関する情報を返します。
資金カスタム フィールドを一覧表示する

資金のカスタム フィールドを一覧表示します。

アクション カスタム フィールドを一覧表示する

操作 ID:
ListActionCustomFields

アクションのカスタム フィールドを一覧表示します。

パラメーター

名前 キー 必須 型 説明
アクション ID
 action_id True string

アクションのシステム レコード ID。

戻り値

カスタム フィールド

本文​​
ConstituentApi.ApiCollectionOfActionCustomFieldRead

アクション カスタム フィールドを作成する

操作 ID:
CreateActionCustomField

新しいアクション カスタム フィールドを作成します。

パラメーター

名前 キー 必須 型 説明
本文
 body True dynamic

作成するカスタム フィールドを表すオブジェクト。

戻り値

作成済みアクション カスタム フィールド

本文​​
ConstituentApi.CreatedActionCustomField

アクション カスタム フィールドを更新する

操作 ID:
EditActionCustomField

アクション カスタム フィールドを更新します。

パラメーター

名前 キー 必須 型 説明
カスタム フィールド ID
 custom_field_id True string

更新するカスタム フィールドのシステム レコード ID。
本文
 body True dynamic

更新するカスタム フィールドのプロパティを表すオブジェクト。

アクションを一覧表示する

操作 ID:
ListActions

アクションの一覧を返します。

パラメーター

名前 キー 必須 型 説明
一覧取得
 list_id string

指定された一覧に含まれる一連のアクションをフィルタリングするために使用される一覧識別子を定義します。 この値が設定されている場合、他の指定されたフィルターは無視されます。
計算されたステータス
 computed_status string

計算されたアクション ステータスに基づく結果のフィルターを表します。 有効な値は、Open、Completed、または PastDue です。
ステータス
 status_code string

結果をフィルタリングするためのアクション ステータス コードを表します (システムがアクション ステータス コードを使用するように構成されている場合にのみ適用されます)。 たとえば、"保留中" はステータスが "保留中" のアクションを返します。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。
以降に追加済
 date_added date-time

指定した日付以降に作成されたアクションに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。
以降に修正済
 last_modified date-time

指定した日付以降に修正されたアクションに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。

戻り値

アクション​​

本文​​
ConstituentApi.ApiCollectionOfActionRead

アクション添付資料を一覧表示する

操作 ID:
ListActionAttachments

アクションの添付資料を一覧表示します。

パラメーター

名前 キー 必須 型 説明
アクション ID
 action_id True string

アクションのシステム レコード ID。

戻り値

Attachments

本文​​
ConstituentApi.ApiCollectionOfActionAttachmentRead

アクション添付資料を作成する

操作 ID:
CreateActionAttachment

新しいアクション添付資料を作成します。

パラメーター

名前 キー 必須 型 説明
アクション ID
 parent_id True string

添付資料に関連付けられたアクションのシステム レコード ID。
タイプ
 type True string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。 指定しない場合、このフィールドは既定で現在の日時になります。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。

戻り値

作成済みアクション添付資料

本文​​
ConstituentApi.CreatedActionAttachment

アクション添付資料を更新する

操作 ID:
EditActionAttachment

アクション添付資料を更新します。

パラメーター

名前 キー 必須 型 説明
添付ファイル ID
 attachment_id True string

更新する添付資料のシステム レコード ID。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。

イベントの参加者オプションを一覧表示する

操作 ID:
ListEventParticipantOptions

イベントの参加者オプションを一覧表示します。

パラメーター

名前 キー 必須 型 説明
イベント ID
 event_id True string

イベントの ID。

戻り値

イベントの参加者オプション

本文​​
EventApi.ApiCollectionOfEventParticipantOption

イベントの参加者オプションを作成する

操作 ID:
CreateEventParticipantOption

イベントの新しい参加者オプションを作成します。

パラメーター

名前 キー 必須 型 説明
イベント ID
 event_id True string

イベントの ID。
件名
 name True string

イベント参加者オプションの名前。
入力の種類
 input_type True string

参加者が応答を提供するために使用できる値の種類。
複数選択を許可?
 multi_select boolean

一覧に対して複数の値を許可しますか?
名前
 name string

一覧オプションの名前。
sequence
 sequence integer

注文に使用される 0 ベースのシーケンス。

戻り値

作成済みイベントの参加者オプション

本文​​
EventApi.CreatedEventParticipantOption

イベントを一覧表示する

操作 ID:
ListEvents

イベントの一覧を返します。

パラメーター

名前 キー 必須 型 説明
カテゴリ
 category string

イベント カテゴリに基づいてフィルタリングします。
開始日 (から)
 start_date_from date

指定した日付以降に開始日があるイベントに結果をフィルタリングします (例: '2020-09-18')。
開始日 (まで)
 start_date_to date

指定した日付以前に開始日があるイベントに結果をフィルタリングします (例: '2020-09-18')。
非アクティブを含む?
 include_inactive boolean

非アクティブなセッションを含みますか?
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 10000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。
イベント ID
 event_id string

指定されたシステム レコード ID に一致するイベントをフィルタリングします。
件名
 name string

指定された名前に一致するイベントをフィルタリングします。
以降に追加済
 date_added date-time

指定した日付以降に作成されたイベントに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。
以降に修正済
 last_modified date-time

指定した日付以降に修正されたイベントに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。

戻り値

イベント

本文​​
EventApi.ApiCollectionOfEventListEntry

イベントを作成する

操作 ID:
CreateEvent

新しいイベントを作成します。

パラメーター

名前 キー 必須 型 説明
イベント名
 name True string

イベントの名前です。
内容
 description string

イベントの説明。
カテゴリ
 name True string

カテゴリ名。
開始日
 start_date True date

イベントの開始日 (例: '2020-09-18')。
開始時刻
 start_time string

イベントの開始時刻 (例: '07:30')。
終了日
 end_date date

イベントの終了日 (例: '2020-09-18')。
終了時刻
 end_time string

イベントの終了時刻 (例: '07:30')。
検索 ID
 lookup_id string

イベントの検索 ID。
容量
 capacity integer

イベントに参加できる人数。
目標
goal double

イベントの目標金額。
キャンペーン ID
 campaign_id string

イベントに関連付けられたキャンペーンのシステム レコード ID。
資金 ID
 fund_id string

イベントに関連付けられた資金のシステム レコード ID。
非アクティブ?
 inactive boolean

イベントはアクティブですか?

戻り値

作成済みイベント

本文​​
EventApi.CreatedEvent

イベントを取得する

操作 ID:
GetEvent

イベントに関する情報を返します。

パラメーター

名前 キー 必須 型 説明
イベント ID
 event_id True string

取得するイベントのシステム レコード ID。

戻り値

イベント

本文​​
EventApi.Event

イベントを更新する

操作 ID:
EditEvent

イベントに関する詳細を更新します。

パラメーター

名前 キー 必須 型 説明
イベント ID
 event_id True string

更新するイベントのシステム レコード ID。
イベント名
 name string

イベントの名前です。
内容
 description string

イベントの説明。
カテゴリ
 name True string

カテゴリ名。
開始日
 start_date date

イベントの開始日 (例: '2020-09-18')。
開始時刻
 start_time string

イベントの開始時刻 (例: '07:30')。
終了日
 end_date date

イベントの終了日 (例: '2020-09-18')。
終了時刻
 end_time string

イベントの終了時刻 (例: '07:30')。
検索 ID
 lookup_id string

イベントの検索 ID。
容量
 capacity integer

イベントに参加できる人数。
目標
goal double

イベントの目標金額。
キャンペーン ID
 campaign_id string

イベントに関連付けられたキャンペーンのシステム レコード ID。
資金 ID
 fund_id string

イベントに関連付けられた資金のシステム レコード ID。
非アクティブ?
 inactive boolean

イベントはアクティブですか?

イベント参加者を一覧表示する

操作 ID:
ListEventParticipants

イベントの参加者を一覧表示します。

パラメーター

名前 キー 必須 型 説明
イベント ID
 event_id True string

イベントのシステム レコード ID。
RSVP ステータス
 rsvp_status string

RSVP ステータスに基づいて参加者をフィルタリングします。
招待の状態
 invitation_status string

招待の状態に基づいて参加者をフィルタリングします。
参加レベル
 participation_level string

関与のレベルに基づいて参加者をフィルタリングします。
参加済?
 attended_filter boolean

出席済みとしてマークされた参加者を含めるかまたは除外するかをフィルタリングします。
手数料支払済?
 fees_paid_filter boolean

手数料を支払った参加者を含めるか除外するかをフィルタリングします。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 10000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。
スタッフ?
 is_constituent_filter boolean

スタッフである参加者を含めるかまたは除外するかをフィルタリングします。
対象となる電子メールあり?
 email_eligible_filter boolean

「電子メール不可」とマークされていない既定電子メール アドレスがあるかどうかに基づいて、参加者を含めるか除外するかをフィルタリングします。
対象となる電話番号あり?
 phone_call_eligible_filter boolean

「電話不可」とマークされていない既定の電話番号があるかどうかに基づいて、参加者を含めるか除外するかをフィルタリングします。
件名
 name string

指定された名前に一致する参加者をフィルタリングします。
以降に追加済
 date_added date-time

指定した日付以降に作成された参加者に結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。
以降に修正済
 last_modified date-time

指定した日付以降に修正された参加者に結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。

戻り値

参加者

本文​​
EventApi.ApiCollectionOfParticipantListEntry

イベント手数料を一覧表示する

操作 ID:
ListEventFees

イベントの手数料を一覧表示します。

パラメーター

名前 キー 必須 型 説明
イベント ID
 event_id True string

イベントのシステム レコード ID。

戻り値

手数料

本文​​
EventApi.ApiCollectionOfEventFee

イベント料金を作成する

操作 ID:
CreateEventFee

イベントの新しい料金を作成します。

パラメーター

名前 キー 必須 型 説明
イベント ID
 event_id True string

イベントのシステム レコード ID。
件名
 name True string

料金の名前。
手数料金額
 cost True double

手数料に関連する金額。
寄付額
 contribution_amount True double

イベントの費用を超える寄付金の金額。

戻り値

作成済みイベント料金

本文​​
EventApi.CreatedEventFee

キャンペーン カスタム フィールドを一覧表示する

操作 ID:
ListCampaignCustomFields

キャンペーンのカスタム フィールドを一覧表示します。

パラメーター

名前 キー 必須 型 説明
キャンペーン ID
 campaign_id True string

キャンペーンのシステム レコード ID。

戻り値

カスタム フィールド

本文​​
FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

キャンペーンのカスタム フィールドを作成する

操作 ID:
CreateCampaignCustomField

新しいキャンペーンのカスタム フィールドを作成します。

パラメーター

名前 キー 必須 型 説明
本文
 body True dynamic

作成するカスタム フィールドを表すオブジェクト。

戻り値

作成済みキャンペーンのカスタム フィールド

本文​​
FundraisingApi.CreatedCampaignCustomField

キャンペーンのカスタム フィールドを更新する

操作 ID:
EditCampaignCustomField

キャンペーンのカスタム フィールドを更新します。

パラメーター

名前 キー 必須 型 説明
カスタム フィールド ID
 custom_field_id True string

更新するカスタム フィールドのシステム レコード ID。
本文
 body True dynamic

更新するカスタム フィールドのプロパティを表すオブジェクト。

キャンペーンのリストの表示

操作 ID:
ListCampaigns

キャンペーンの一覧を返します。

パラメーター

名前 キー 必須 型 説明
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。
非アクティブを含む?
 include_inactive boolean

非アクティブなキャンペーンを含みますか?
以降に追加済
 date_added date-time

指定した日付以降に作成されたキャンペーンに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。
以降に修正済
 last_modified date-time

指定した日付以降に修正されたキャンペーンに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。

戻り値

キャンペーン

本文​​
FundraisingApi.ApiCollectionOfCampaignRead

キャンペーンの添付ファイルを作成する

操作 ID:
CreateCampaignAttachment

新しいキャンペーンの添付ファイルを作成します。

パラメーター

名前 キー 必須 型 説明
キャンペーン ID
 parent_id True string

添付資料に関連付けられたキャンペーンのシステム レコード ID。
タイプ
 type True string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。 指定しない場合、このフィールドは既定で現在の日時になります。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。

戻り値

作成済みキャンペーン添付資料

本文​​
FundraisingApi.CreatedCampaignAttachment

キャンペーンを取得する

操作 ID:
GetCampaign

キャンペーンに関する情報を返します。

パラメーター

名前 キー 必須 型 説明
キャンペーン ID
 campaign_id True string

取得するキャンペーンのシステム レコード ID。

戻り値

キャンペーン

本文​​
FundraisingApi.CampaignRead

キャンペーン添付資料を一覧表示する

操作 ID:
ListCampaignAttachments

キャンペーンの添付資料を一覧表示します。

パラメーター

名前 キー 必須 型 説明
キャンペーン ID
 campaign_id True string

キャンペーンのシステム レコード ID。

戻り値

Attachments

本文​​
FundraisingApi.ApiCollectionOfCampaignAttachmentRead

キャンペーン添付資料を更新する

操作 ID:
EditCampaignAttachment

キャンペーン添付資料を更新します。

パラメーター

名前 キー 必須 型 説明
添付ファイル ID
 attachment_id True string

更新する添付資料のシステム レコード ID。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。

ギフト カスタム フィールドを一覧表示する

操作 ID:
ListGiftCustomFields

ギフトのカスタム フィールドを一覧表示します。

パラメーター

名前 キー 必須 型 説明
ギフト ID
 gift_id True string

贈与のシステム レコード ID。

戻り値

カスタム フィールド

本文​​
GiftApi.ApiCollectionOfGiftCustomFieldRead

ギフト バッチの一覧

操作 ID:
ListGiftBatches

ギフト バッチを一覧で表示します。

パラメーター

名前 キー 必須 型 説明
バッチ番号
 batch_number string

指定した数と一致する結果に対するフィルターを表します。
承認済みかどうか
 approved boolean

ギフト バッチの状態に対するフィルターを表します。
例外があるかどうか
 has_exceptions boolean

ギフト バッチが例外を含むかどうかに対するフィルターを表します。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。
検索テキスト
 search_text string

バッチの説明やバッチ番号のフィールドに含まれるテキストに対するフィルターを表します。
作成者
 created_by string

指定したユーザーが作成したギフト バッチに対するフィルターを表します。

戻り値

贈与バッチ

本文​​
GiftBatchApi.ApiCollectionOfGiftBatch

ギフト バッチを作成する

操作 ID:
CreateGiftBatch

新しいギフト バッチを作成します。

パラメーター

名前 キー 必須 型 説明
内容
 batch_description string

バッチの説明。
見積もり件数
 expected_number integer

バッチが含む贈与の予想数。
見積もり合計
 expected_batch_total double

バッチが含む贈与の合計額。
バッチ番号
 batch_number string

バッチに固有の一意識別子。

戻り値

作成した贈与バッチ

本文​​
GiftBatchApi.CreatedBatch

ギフトのカスタム フィールドを作成する

操作 ID:
CreateGiftCustomField

新しいギフトのカスタム フィールドを作成します。

パラメーター

名前 キー 必須 型 説明
本文
 body True dynamic

作成するカスタム フィールドを表すオブジェクト。

戻り値

作成済みギフトのカスタム フィールド

本文​​
GiftApi.CreatedGiftCustomField

ギフトのカスタム フィールドを更新する

操作 ID:
EditGiftCustomField

ギフトのカスタム フィールドを更新します。

パラメーター

名前 キー 必須 型 説明
カスタム フィールド ID
 custom_field_id True string

更新するカスタム フィールドのシステム レコード ID。
本文
 body True dynamic

更新するカスタム フィールドのプロパティを表すオブジェクト。

ギフトの添付資料を一覧表示する

操作 ID:
ListGiftAttachments

ギフトの添付資料を一覧表示します。

パラメーター

名前 キー 必須 型 説明
ギフト ID
 gift_id True string

贈与のシステム レコード ID。

戻り値

Attachments

本文​​
GiftApi.ApiCollectionOfGiftAttachmentRead

ギフトを一覧表示する

操作 ID:
ListGifts

ギフトの一覧を返します。

パラメーター

名前 キー 必須 型 説明
一覧取得
 list_id string

指定された一覧に含まれる一連のギフトをフィルタリングするために使用される一覧識別子を定義します。 この値が設定されている場合、他の指定されたフィルターは無視されます。
タイプ
 gift_type string

結果をフィルタリングするギフトの種類のコンマ区切り一覧を表します。 たとえば、"MatchingGiftPledge,RecurringGift" は、ギフトの種類 MatchingGiftPledge または RecurringGift のみを返します。
スタッフ ID
 constituent_id string

結果をフィルタリングするスタッフ識別子のコンマ区切り一覧を表します。 たとえば、"280,1232" はスタッフ 280 またはスタッフ 1232 からのギフトのみを返します。
キャンペーン ID
 campaign_id string

結果をフィルタリングするキャンペーン識別子のコンマ区切り一覧を表します。 たとえば、"506,918" は、キャンペーン 506 またはキャンペーン 918 へのギフトのみを返します。
資金 ID
 fund_id string

結果をフィルタリングする資金識別子のコンマ区切り一覧を表します。 たとえば、"506,918" は、資金 506 または資金 918 へのギフトのみを返します。
訴求力 ID
 appeal_id string

結果をフィルタリングする異議申し立て識別子のコンマ区切り一覧を表します。 たとえば、"506,918" は、異議申し立て 506 または異議申し立て 918 へのギフトのみを返します。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。
ギフト開始日
 start_gift_date date-time

指定された日付以降のギフト日付があるギフトのフィルターを表します (例: '2020-09-18T04:13:56Z')。
ギフト終了日
 end_gift_date date-time

指定された日付以前のギフト日付があるギフトのフィルターを表します (例: '2020-09-18T04:13:56Z')。
ギフトの最小額
 start_gift_amount double

指定された金額以上の額のギフトのフィルターを表します。
ギフトの最大額
 end_gift_amount double

指定された金額以下の額のギフトのフィルターを表します。
転記の状態
 post_status string

結果をフィルタリングするギフト転記の状態のコンマ区切り一覧を表します。 たとえば、"DoNotPost,Posted" は、DoNotPost または Posted としてマークされているギフトのみを返します。
領収書の状態
 receipt_status string

結果をフィルタリングするギフト領収書の状態のコンマ区切り一覧を表します。 たとえば、"DoNotReceipt,Receipted" は、DoNotReceipt または Receipted としてマークされているギフトのみを返します。
受信確認の状態
 acknowledgement_status string

結果をフィルタリングする受信確認の状態のコンマ区切り一覧を表します。 たとえば、"DoNotAcknowledge,Acknowledged" は、DoNotAcknowledge または Acknowledged としてマークされているギフトのみを返します。
以降に追加済
 date_added date-time

指定した日付以降に作成されたギフトに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。
以降に修正済
 last_modified date-time

指定した日付以降に修正されたギフトに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。

戻り値

ギフト

本文​​
GiftApi.ApiCollectionOfGiftRead

ギフトを作成する

操作 ID:
CreateGift

新しいギフトを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

ギフトに関連付けられたスタッフのシステム レコード ID。
金額
 value True double

ギフトの金額。
日
 date True date

贈与の日付 (例: '2020-09-18')。
タイプ
 type True string

ギフトの種類。
キャンペーン ID
 campaign_id string

贈与分割に関連付けられたキャンペーンのシステム レコード ID。
資金 ID
 fund_id True string

贈与分割に関連付けられた資金のシステム レコード ID。
異議申し立て ID
 appeal_id string

贈与分割に関連付けられた異議申し立てのシステム レコード ID。
パッケージ ID
 package_id string

贈与分割に関連付けられたパッケージのシステム レコード ID。
金額
 value True double

贈与分割の金額。
支払方法
 payment_method True string

支払方法。
小切手番号
 check_number string

小切手番号 (支払方法が "個人的小切手" の場合のみ適用されます)。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
参照
 reference string

支払参照 (支払方法が "その他" の場合のみ適用されます)。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
匿名かどうか
 is_anonymous boolean

匿名贈与かどうか 値を指定しない場合は、既定の寄付者の匿名性を使用します。
サブタイプ
 subtype string

ギフトのサブタイプ。
コメント
 reference string

ギフトに関する特別な情報 (ギフトに対するモチベーションや、現物ギフトの詳しい説明など) を追跡するメモです。
検索 ID
 lookup_id string

このギフトのユーザーが定義した識別子。
基金調達者クレジットを使用しますか?
 default_fundraiser_credits boolean

既定の基金調達者クレジットを使用しますか?
ソフト クレジットを使用しますか?
 default_soft_credits boolean

既定のソフト クレジットを使用しますか?
購買者層
 constituency string

ギフトの購買者層。
バッチ接頭辞
 batch_prefix string

バッチ ギフトに使用する接頭辞。 これには少なくとも 1 文字が含まれている必要があり、'バッチ番号' に値がある場合に必要になります。
バッチ番号
 batch_number string

バッチ番号。 文字数制限: 50 (バッチ接頭辞を含む)。
転記の状態
 post_status string

贈与の転記の状態。
転記日
 post_date date

贈与の転記日 (例: '2020-09-18')。
領収書の状態
 status True string

贈与の領収書の状態。
領収書の金額
 value True double

ギフトの領収書の金額。
受領日
 date date

贈与を受け取った日付です (例: '2020-09-18')。

戻り値

作成済みギフト

本文​​
GiftApi.CreatedGift

ギフトを取得する

操作 ID:
GetGift

ギフトに関する情報を返します。

パラメーター

名前 キー 必須 型 説明
ギフト ID
 gift_id True string

取得するギフトのシステム レコード ID。

戻り値

贈答業

本文​​
GiftApi.GiftRead

ギフト受信確認の詳細を更新する

操作 ID:
EditGiftAcknowledgement

ギフトの受信確認の詳細を更新します。

パラメーター

名前 キー 必須 型 説明
受信確認 ID
 acknowledgement_id True string

更新するギフト受信確認のシステム レコード ID。 親ギフトの ID を値として使用します。
ステータス
 status string

受信確認のステータス。 ステータスが DoNotAcknowledge に設定されている場合、文字と日付は null である必要があります。 ステータスが NeedsAcknowledgement に設定されている場合、日付は null である必要があります。
日
 date date-time

受信確認に関連付けられた日付 (例: '2020-09-18T04:13:56Z')。
レター
letter string

受信確認に関連付けられた文字。

ギフト添付資料を作成する

操作 ID:
CreateGiftAttachment

新しいギフト添付資料を作成します。

パラメーター

名前 キー 必須 型 説明
ギフト ID
 parent_id True string

添付資料に関連付けられたギフトのシステム レコード ID。
タイプ
 type True string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。 指定しない場合、このフィールドは既定で現在の日時になります。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。

戻り値

作成済みギフト添付資料

本文​​
GiftApi.CreatedGiftAttachment

ギフト添付資料を更新する

操作 ID:
EditGiftAttachment

ギフト添付資料を更新します。

パラメーター

名前 キー 必須 型 説明
添付ファイル ID
 attachment_id True string

更新する添付資料のシステム レコード ID。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。

ギフト領収書の詳細を更新する

操作 ID:
EditGiftReceipt

ギフトの領収書の詳細を更新します。

パラメーター

名前 キー 必須 型 説明
領収書 ID
 receipt_id True string

更新するギフト領収書のシステム レコード ID。 親ギフトの ID を値として使用します。
ステータス
 status string

贈与の領収書の状態。 ステータスが NeedsReceipt または DoNotReceipt に設定されている場合、領収書の日付は null である必要があります。
値
 value double

金額。
日
 date date-time

領収書の日付 (例: '2020-09-18T04:13:56Z')。
数
 number integer

領収書の番号。

スタッフ アクションを一覧表示する

操作 ID:
ListConstituentActions

スタッフのアクションを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

アクション​​

本文​​
ConstituentApi.ApiCollectionOfActionRead

スタッフ アクションを作成する

操作 ID:
CreateAction

新しいスタッフ アクションを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

アクションに関連付けられたスタッフのシステム レコード ID。
カテゴリ
 category True string

スタッフ対話のチャネルまたは意図。
完了済?
 completed boolean

アクションは完了しましたか? システムがカスタム アクションの状態を使用するように構成されている場合、この値はアクションの状態値に基づいています。
完了日
 completed_date date-time

アクションが完了した日付 (例: '2020-09-18T04:13:56Z')。
日
 date True date-time

アクションの日付 (例: '2020-09-18T04:13:56Z')。
メモ
description string

アクション サマリーを補足する詳細説明。
通信方向
 direction string

アクションの方向。
基金調達者
 fundraisers array of string

アクションに関連付けられた基金調達者に対する一連のシステム レコード ID。
場所
 location string

アクションの場所。
営業案件 ID
 opportunity_id string

アクションに関連付けられた営業案件のシステム レコード ID。
結果
 outcome string

アクションの結果。
優先順位
 priority string

アクションの優先度。
開始時刻
 start_time string

アクションの開始時間。 HH:mm 形式で 24 時間制を使用します。
終了時刻
 end_time string

アクションの終了時間。 HH:mm 形式で 24 時間制を使用します。
ステータス
 status string

アクションの状態。
サマリー
 summary string

レコードの上部に表示されるアクションの簡単な説明。 文字数制限: 255。
タイプ
 type string

カテゴリを補完するアクションの追加説明。

戻り値

作成済みアクション

本文​​
ConstituentApi.CreatedAction

スタッフ アクションを取得する

操作 ID:
GetAction

スタッフ アクションに関する情報を返します。

パラメーター

名前 キー 必須 型 説明
アクション ID
 action_id True string

取得するアクションのシステム レコード ID。

戻り値

操作​​

本文​​
ConstituentApi.ActionRead

スタッフ アクションを更新する

操作 ID:
EditAction

スタッフ アクションを更新します。

パラメーター

名前 キー 必須 型 説明
アクション ID
 action_id True string

更新するアクションのシステム レコード ID。
カテゴリ
 category string

スタッフ対話のチャネルまたは意図。
完了済?
 completed boolean

アクションは完了しましたか? システムがカスタム アクションの状態を使用するように構成されている場合、この値はアクションの状態値に基づいています。
完了日
 completed_date date-time

アクションが完了した日付 (例: '2020-09-18T04:13:56Z')。
日
 date date-time

アクションの日付 (例: '2020-09-18T04:13:56Z')。
メモ
description string

アクション サマリーを補足する詳細説明。
通信方向
 direction string

アクションの方向。
基金調達者
 fundraisers array of string

アクションに関連付けられた基金調達者に対する一連のシステム レコード ID。
場所
 location string

アクションの場所。
営業案件 ID
 opportunity_id string

アクションに関連付けられた営業案件のシステム レコード ID。
結果
 outcome string

アクションの結果。
優先順位
 priority string

アクションの優先度。
開始時刻
 start_time string

アクションの開始時間。 HH:mm 形式で 24 時間制を使用します。
終了時刻
 end_time string

アクションの終了時間。 HH:mm 形式で 24 時間制を使用します。
ステータス
 status string

アクションの状態。
サマリー
 summary string

レコードの上部に表示されるアクションの簡単な説明。 文字数制限: 255。
タイプ
 type string

カテゴリを補完するアクションの追加説明。

スタッフ エイリアスを作成する

操作 ID:
CreateConstituentAlias

新しいスタッフ エイリアスを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

エイリアスに関連付けられたスタッフのシステム レコード ID。
エイリアス
 name True string

スタッフのエイリアスとして使用する名前。 文字数制限: 100。
タイプ
 type string

エイリアスの種類。

戻り値

作成済みスタッフ エイリアス

本文​​
ConstituentApi.CreatedConstituentAlias

スタッフ エイリアスを更新する

操作 ID:
EditConstituentAlias

スタッフ エイリアスを更新します。

パラメーター

名前 キー 必須 型 説明
エイリアス ID
 alias_id True string

更新するエイリアスのシステム レコード ID。
エイリアス
 name string

スタッフのエイリアスとして使用する名前。 文字数制限: 100。
タイプ
 type string

エイリアスの種類。

スタッフ カスタム フィールドを一覧表示する

操作 ID:
ListConstituentCustomFields

スタッフのカスタム フィールドを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

カスタム フィールド

本文​​
ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

スタッフ コードを一覧表示する

操作 ID:
ListConstituentCodes

スタッフのスタッフ コードを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

スタッフ コード

本文​​
ConstituentApi.ApiCollectionOfConstituentCodeRead

スタッフ コードを作成する

操作 ID:
CreateConstituentCode

新しいスタッフ コードを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフ コードに関連付けられたスタッフのシステム レコード ID。
スタッフ コード
 description True string

スタッフ コード。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
シーケンス
 sequence integer

スタッフ コードに関連付けられた数列。

戻り値

作成済みスタッフ コード

本文​​
ConstituentApi.CreatedConstituentCode

スタッフ コードを削除する

操作 ID:
DeleteConstituentCode

スタッフ コードを削除します。

パラメーター

名前 キー 必須 型 説明
スタッフ コード ID
 constituent_code_id True string

削除するスタッフ コードのシステム レコード ID。

スタッフ コードを更新する

操作 ID:
EditConstituentCode

スタッフ コードを更新します。

パラメーター

名前 キー 必須 型 説明
スタッフ コード ID
 constituent_code_id True string

更新するスタッフ コードのシステム レコード ID。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
シーケンス
 sequence integer

スタッフ コードに関連付けられた数列。

スタッフ プロファイル画像を取得する

操作 ID:
GetConstituentProfilePicture

スタッフの現在のプロファイル画像を返します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

プロファイル画像を取得するスタッフのシステム レコード ID。

戻り値

プロファイル画像

本文​​
ConstituentApi.ProfilePictureRead

スタッフ プロファイル画像を更新する

操作 ID:
EditConstituentProfilePicture

スタッフの現在のプロファイル画像を更新します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

プロファイル画像を更新するスタッフのシステム レコード ID。
ファイル名
 file_name True string

ファイルの名前。
ドキュメント ID
 document_id True uuid

ドキュメントの識別子。
サムネイル ID
 thumbnail_id True uuid

サムネイル ドキュメントの識別子。

スタッフ メモを一覧表示する

操作 ID:
ListConstituentNotes

スタッフのメモを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

メモ

本文​​
ConstituentApi.ApiCollectionOfNoteRead

スタッフ メモを作成する

操作 ID:
CreateConstituentNote

新しいスタッフ メモを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

メモに関連付けられたスタッフのシステム レコード ID。
タイプ
 type True string

メモの種類。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
サマリー
 summary string

メモの概要。 文字数制限: 50。
メモ
text string

メモのテキスト。

戻り値

作成済みスタッフ メモ

本文​​
ConstituentApi.CreatedConstituentNote

スタッフ メモを更新する

操作 ID:
EditConstituentNote

スタッフ メモを更新します。

パラメーター

名前 キー 必須 型 説明
メモ ID
 note_id True string

更新するメモのシステム レコード ID。
タイプ
 type string

メモの種類。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
サマリー
 summary string

メモの概要。 文字数制限: 50。
メモ
text string

メモのテキスト。

スタッフのエイリアスを一覧表示する

操作 ID:
ListConstituentAliases

スタッフのエイリアスを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

エイリアス

本文​​
ConstituentApi.ApiCollectionOfAliasRead

スタッフのオンライン プレゼンスを一覧表示する

操作 ID:
ListConstituentOnlinePresences

スタッフのオンライン プレゼンスを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
非アクティブを含む?
 include_inactive boolean

非アクティブのオンライン プレゼンスを含みますか?

戻り値

オンライン プレゼンス

本文​​
ConstituentApi.ApiCollectionOfOnlinePresenceRead

スタッフのオンライン プレゼンスを作成する

操作 ID:
CreateConstituentOnlinePresence

新しいスタッフのオンライン プレゼンスを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

オンライン プレゼンスに関連付けられたスタッフのシステム レコード ID。
タイプ
 type True string

オンライン プレゼンスの種類。
リンク
 address True string

オンライン プレゼンスの Web アドレス。
プライマリ?
 primary boolean

これはスタッフの優先オンライン プレゼンスですか?
非アクティブ?
 inactive boolean

このオンライン プレゼンスは非アクティブですか?

戻り値

作成済みスタッフのオンライン プレゼンス

本文​​
ConstituentApi.CreatedConstituentOnlinePresence

スタッフのオンライン プレゼンスを更新する

操作 ID:
EditConstituentOnlinePresence

スタッフのオンライン プレゼンスを更新します。

パラメーター

名前 キー 必須 型 説明
オンライン プレゼンス ID
 online_presence_id True string

更新するオンライン プレゼンスのシステム レコード ID。
タイプ
 type string

オンライン プレゼンスの種類。
リンク
 address string

オンライン プレゼンスの Web アドレス。
プライマリ?
 primary boolean

これはスタッフの優先オンライン プレゼンスですか?
非アクティブ?
 inactive boolean

このオンライン プレゼンスは非アクティブですか?

スタッフのカスタム フィールドを作成する

操作 ID:
CreateConstituentCustomField

新しいスタッフのカスタム フィールドを作成します。

パラメーター

名前 キー 必須 型 説明
本文
 body True dynamic

作成するカスタム フィールドを表すオブジェクト。

戻り値

作成済みスタッフのカスタム フィールド

本文​​
ConstituentApi.CreatedConstituentCustomField

スタッフのカスタム フィールドを更新する

操作 ID:
EditConstituentCustomField

スタッフのカスタム フィールドを更新します。

パラメーター

名前 キー 必須 型 説明
カスタム フィールド ID
 custom_field_id True string

更新するカスタム フィールドのシステム レコード ID。
本文
 body True dynamic

更新するカスタム フィールドのプロパティを表すオブジェクト。

スタッフの住所を一覧表示する

操作 ID:
ListConstituentAddresses

スタッフの住所を一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
非アクティブを含む?
 include_inactive boolean

非アクティブな住所を含みますか？

戻り値

住所

本文​​
ConstituentApi.ApiCollectionOfAddressRead

スタッフの同意レコードを一覧表示する

操作 ID:
ListConstituentConsents

スタッフの同意レコードを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
最新のみ?
 most_recent_only boolean

各チャネル カテゴリの組み合わせに対する最新の同意レコードのみを応答に含めますか?

戻り値

同意レコード

本文​​
CommPrefApi.ConstituentConsentReadCollection

スタッフの同意レコードを作成する

操作 ID:
CreateConstituentConsent

新しいスタッフの同意レコードを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

同意レコードに関連付けられたスタッフのシステム レコード ID。
チャネル
 channel True string

同意応答が適用されるチャネル。
カテゴリ
 category string

同意応答が適用されるカテゴリ。
ソース
 source string

スタッフからの同意応答のソース。
回答
 constituent_consent_response True string

指定されたチャネル/カテゴリの同意に対するスタッフの応答方法。
日
 consent_date True date-time

同意応答が受信された日付 (例: '2020-09-18T04:13:56Z')。
同意書
 consent_statement string

同意時にスタッフが応答したステートメント。
プライバシー通知
 privacy_notice string

スタッフに提供されるプライバシーに関する声明。

戻り値

作成済みスタッフ同意

本文​​
CommPrefApi.CreatedConstituentConsent

スタッフの最初のギフトを取得する

操作 ID:
GetConstituentFirstGift

スタッフに対する最初の贈与を返します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

寄付の概要

本文​​
ConstituentApi.GivingSummaryRead

スタッフの最新ギフトを取得する

操作 ID:
GetConstituentLatestGift

スタッフの最新ギフトを返します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

寄付の概要

本文​​
ConstituentApi.GivingSummaryRead

スタッフの最高ギフトを取得する

操作 ID:
GetConstituentGreatestGift

スタッフに対する最大の贈与を返します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

寄付の概要

本文​​
ConstituentApi.GivingSummaryRead

スタッフの生涯寄付を取得します

操作 ID:
GetConstituentLifetimeGiving

スタッフの生涯寄付について概要を返します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

生涯寄付

本文​​
ConstituentApi.LifetimeGivingRead

スタッフの見込顧客の状態を取得する

操作 ID:
GetConstituentProspectStatus

スタッフの現在の見込顧客の状態を返します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

見込顧客の状態を取得する対象スタッフのシステム レコード ID。

戻り値

見込顧客の状態

本文​​
ConstituentApi.ProspectStatusRead

スタッフの評価を一覧表示する

操作 ID:
ListConstituentRatings

スタッフの評価の一覧を返します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID
非アクティブを含む?
 include_inactive boolean

非アクティブな評価を含みますか？
最新のみ?
 most_recent_only boolean

最新の評価のみを含みますか?

戻り値

評価

本文​​
ConstituentApi.ApiCollectionOfRatingRead

スタッフの評価を作成する

操作 ID:
CreateConstituentRating

新しいスタッフの評価を作成します。

パラメーター

名前 キー 必須 型 説明
本文
 body True dynamic

作成する評価を表すオブジェクト。

戻り値

作成済みスタッフの評価

本文​​
ConstituentApi.CreatedConstituentRating

スタッフの電子メール アドレスを一覧表示する

操作 ID:
ListConstituentEmailAddresses

スタッフの電子メール アドレスを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
非アクティブを含む?
 include_inactive boolean

非アクティブな電子メール アドレスを含みますか?

戻り値

電子メール アドレス

本文​​
ConstituentApi.ApiCollectionOfEmailAddressRead

スタッフの電子メール アドレスを作成する

操作 ID:
CreateConstituentEmailAddress

新しいスタッフの電子メール アドレスを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

電子メール アドレスに関連付けられたスタッフのシステム レコード ID。
電子メールの種類
 type True string

電子メール アドレスの種類。
メール アドレス
 address True string

電子メール アドレス。
プライマリ?
 primary boolean

これはスタッフの優先電子メール アドレスですか?
電子メール不可?
 do_not_email boolean

この電子メール アドレスでスタッフに連絡できますか?
非アクティブ?
 inactive boolean

この電子メール アドレスは非アクティブですか?

戻り値

作成済みスタッフの電子メール アドレス

本文​​
ConstituentApi.CreatedConstituentEmailAddress

スタッフの電子メール アドレスを更新する

操作 ID:
EditConstituentEmailAddress

スタッフの電子メール アドレスを更新します。

パラメーター

名前 キー 必須 型 説明
電子メール アドレス ID
 email_address_id True string

更新する電子メール アドレスのシステム レコード ID。
電子メールの種類
 type string

電子メール アドレスの種類。
メール アドレス
 address string

電子メール アドレス。
プライマリ?
 primary boolean

これはスタッフの優先電子メール アドレスですか?
電子メール不可?
 do_not_email boolean

この電子メール アドレスでスタッフに連絡できますか?
非アクティブ?
 inactive boolean

この電子メール アドレスは非アクティブですか?

スタッフの電話番号を一覧表示する

操作 ID:
ListConstituentPhones

スタッフの電話番号を一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
非アクティブを含む?
 include_inactive boolean

非アクティブな電話番号を含みますか?

戻り値

電話

本文​​
ConstituentApi.ApiCollectionOfPhoneRead

スタッフの電話番号を作成する

操作 ID:
CreateConstituentPhone

新しいスタッフの電話番号を作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

電話番号に関連付けられたスタッフのシステム レコード ID。
タイプ
 type True string

電話番号の種類。
数
 number True string

電話番号。
プライマリ?
 primary boolean

これはスタッフの優先電話番号ですか?
電話不可?
 do_not_call boolean

この電話番号でスタッフに連絡できますか?
非アクティブ?
 inactive boolean

この電話番号は非アクティブですか?

戻り値

作成済みスタッフの電話番号

本文​​
ConstituentApi.CreatedConstituentPhone

スタッフの電話番号を更新する

操作 ID:
EditConstituentPhone

スタッフの電話番号を更新します。

パラメーター

名前 キー 必須 型 説明
電話番号 ID
 phone_id True string

更新する電話番号のシステム レコード ID。
タイプ
 type string

電話番号の種類。
数
 number string

電話番号。
プライマリ?
 primary boolean

これはスタッフの優先電話番号ですか?
電話不可?
 do_not_call boolean

この電話番号でスタッフに連絡できますか?
非アクティブ?
 inactive boolean

この電話番号は非アクティブですか?

スタッフを一覧表示する

操作 ID:
ListConstituents

スタッフの一覧を返します。

パラメーター

名前 キー 必須 型 説明
一覧取得
 list_id string

指定された一覧に含まれる一連のスタッフをフィルタリングするために使用される一覧識別子を定義します。 この値が設定されている場合、他の指定されたフィルターは無視されます。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。
スタッフ コード
 constituent_code string

一覧をフィルタリングするスタッフ コードを表します。 たとえば、"取締役会役員" は、取締役会役員スタッフ コードを持つスタッフのみを返します。
スタッフ ID
 constituent_id string

結果をフィルタリングするスタッフ識別子のコンマ区切り一覧を表します。 たとえば、"280,1232" はスタッフ 280 またはスタッフ 1232 のみを返します。
カスタム フィールド カテゴリ
 custom_field_category string

結果をフィルタリングするカスタム フィールド カテゴリを表します。 たとえば、"記念日" は、アクティブな記念日カスタム フィールドを持つスタッフのみを返します。
基金調達者ステータス
 fundraiser_status string

結果をフィルタリングする基金調達者ステータスのコンマ区切り一覧を表します。 たとえば、"アクティブ、なし" は、基金調達者ステータスが「アクティブ」または「なし」であるスタッフのみを返します。 このフィルターの有効な値は、「アクティブ」、「非アクティブ」、および「なし」です。
故人を含む?
 include_deceased boolean

故人であるスタッフを応答に含めますか?
非アクティブを含む?
 include_inactive boolean

非アクティブ スタッフを応答に含めますか?
郵便番号
 postal_code string

結果をフィルタリングする郵便番号のコンマ区切り一覧を表します。 たとえば、"29466,29492" は、優先住所の郵便番号が 29466、29492、または 29492-0727 などの 29466 または 29492 で始まるスタッフのみを返します。
以降に追加済
 date_added date-time

指定した日付以降に作成されたスタッフに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。
以降に修正済
 last_modified date-time

指定した日付以降に修正されたスタッフに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。
並べ替え基準
 sort string

結果を並べ替えるフィールドの一覧を表します。 結果は既定で昇順の並べ替えであり、'-' 記号は降順の並べ替えを示します。 たとえば、"date_added,-last" は、スタッフを "date_added" フィールドで昇順で並べ替え、次に "last" フィールドで降順で並べ替えます。

戻り値

スタッフ

本文​​
ConstituentApi.ApiCollectionOfConstituentRead

スタッフを取得する

操作 ID:
GetConstituent

スタッフに関する情報を返します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

取得するスタッフのシステム レコード ID。

戻り値

スタッフ

本文​​
ConstituentApi.ConstituentRead

スタッフを更新する

操作 ID:
EditConstituent

スタッフを更新します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

更新するスタッフのシステム レコード ID。
敬称
 title string

スタッフの主な役職 (個人のみ)。
名
 first string

スタッフの名 (個人のみ)。 文字数制限: 50。
姓
 last string

スタッフの姓 (個人のみ)。 文字数制限: 100。
組織名
 name string

個人の場合、これは編集操作には適用されない計算フィールドです。 組織の場合、このフィールドは必須であり、組織の名前を表します。 文字数制限: 100。
敬称
 suffix string

スタッフの主な敬称 (個人のみ)。
希望する名前
 preferred_name string

スタッフの希望する名前 (個人のみ)。 文字数制限: 50。
検索 ID
 lookup_id string

スタッフのユーザー定義した識別子。
性別
 gender string

スタッフの性別 (個人のみ)。
ミドルネーム
 middle string

スタッフのミドル ネーム (個人のみ)。 文字数制限: 50。
旧名
 former_name string

スタッフの旧名 (個人のみ)。 文字数制限: 100。
役職 2
 title_2 string

スタッフのセカンダリ役職 (個人のみ)。
敬称 2
 suffix_2 string

スタッフのセカンダリ敬称 (個人のみ)。
婚姻区分
 marital_status string

スタッフの婚姻区分 (個人のみ)。
匿名?
 gives_anonymously boolean

スタッフは匿名ですか?
非アクティブ?
 inactive boolean

スタッフは非アクティブですか?
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
出生地
 birthplace string

スタッフの出生地 (個人のみ)。
民族
 ethnicity string

スタッフの民族 (個人のみ)。
収益
 income string

スタッフの収入 (個人のみ)。
宗教
 religion string

スタッフの宗教 (個人のみ)。
業種
 industry string

スタッフの業種 (組織のみ)。
従業員数
 num_employees integer

組織の従業員数。
ギフトと一致?
 matches_gifts boolean

組織はギフトと一致していますか?
一致するギフト要素
 matching_gift_factor double

一致するギフト要素 (組織のみ)。
ギフトあたりの最小一致
 value double

スタッフのギフトあたりの最小一致額 (組織のみ)。
ギフトあたりの最大一致
 value double

スタッフのギフトあたりの最大一致額 (組織のみ)。
スタッフあたりの最小一致
 value double

スタッフの最小一致合計 (組織のみ)。
スタッフあたりの最大一致
 value double

スタッフの最大一致合計 (組織のみ)。
一致するギフト メモ
 matching_gift_notes string

スタッフの一致するギフト メモ (組織のみ)。
故人?
 deceased boolean

故人であるスタッフですか (個人のみ)?
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。

スタッフを検索する

操作 ID:
SearchConstituent

指定された検索テキストに基づいてスタッフ検索を実行します。 名、姓、優先名、旧名、エイリアス、電子メール アドレス、電話番号、アドレス、または検索 ID をサポートします。 名と姓、または優先名と姓など、名前の組み合わせは有効ですが、検索は一度に 1 つのパラメーターのみをサポートします。 既定では、検索には条件に類似した結果が含まれます。 たとえば、"Smith" の検索には、"Smyth" やその他の代替スペルの一致が含まれます。 この検索では、* や？などのワイルドカード文字はサポートされていません。 検索結果は 500 レコードに制限されています。

パラメーター

名前 キー 必須 型 説明
検索テキスト
 search_text True string

検索テキスト。 名、姓、優先名、旧名、エイリアス、電子メール アドレス、電話番号、アドレス、または検索 ID をサポートします。 名と姓、または優先名と姓など、名前の組み合わせは有効ですが、検索は一度に 1 つのパラメーターのみをサポートします。 既定では、検索には条件に類似した結果が含まれます。 たとえば、"Smith" の検索には、"Smyth" やその他の代替スペルの一致が含まれます。 この検索では、* や？などのワイルドカード文字はサポートされていません。 検索結果は 500 レコードに制限されています。
基金調達者ステータス
 fundraiser_status string

結果をフィルタリングする基金調達者ステータスのコンマ区切り一覧を表します。 たとえば、"アクティブ、なし" は、基金調達者ステータスが「アクティブ」または「なし」であるスタッフのみを返します。 このフィルターの有効な値は、「アクティブ」、「非アクティブ」、および「なし」です。
非アクティブを含む?
 include_inactive boolean

非アクティブ スタッフを応答に含めますか?
検索フィールド
 search_field string

検索するフィールドを表します。 現在、lookup_id のみをサポートしています。 search_text が指定されている場合、search_text と一致する lookup_id があるスタッフが返されます。
制限検索を使用?
 strict_search boolean

名前が検索テキストのように聞こえるが、スペルが異なるスタッフを除外しますか?
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。

戻り値

検索結果

本文​​
ConstituentApi.ApiCollectionOfSearchResultRead

スタッフ住所を作成する

操作 ID:
CreateConstituentAddress

新しいスタッフ住所を作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

住所に関連付けられたスタッフのシステム レコード ID。
住所の種類
 type True string

住所の種類。
国
 country string

住所の国 (ID、名前、または略語形の場合があります)。
住所行
 address_lines string

住所行。
市
 city string

住所の市 (区町村フィールドと組み合わせて使用しないでください)。
完了状態
 state string

住所の状態。
郵便番号
 postal_code string

住所の郵便番号。
区町村
 suburb string

住所の区町村 (市フィールドと組み合わせて使用しないでください)。
国
 county string

住所の郡。
情報元
 information_source string

住所の情報元。
リージョン
 region string

住所の地域。
CART
 cart string

住所の配送ルート (CART)。
LOT
 lot string

住所の移動ライン (LOT)。
DPC
 dpc string

住所の配送ポイント コード (DPC)。
有効開始日
 start date

スタッフがこの住所に居住し始めた日付 (例: '2005-09-18')。
有効最終日
 end date

スタッフがこの住所に居住しなくなった日付 (例: '2005-09-18')。
プライマリ?
 preferred boolean

これはスタッフの優先アドレスですか?
郵送不可?
 do_not_mail boolean

この住所でスタッフに連絡できますか?
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。

戻り値

作成済みスタッフ住所

本文​​
ConstituentApi.CreatedConstituentAddress

スタッフ住所を更新する

操作 ID:
EditConstituentAddress

スタッフ住所を更新します。

パラメーター

名前 キー 必須 型 説明
住所 ID
 address_id True string

更新する住所のシステム レコード ID。
住所の種類
 type string

住所の種類。
国
 country string

住所の国 (ID、名前、または略語形の場合があります)。
住所行
 address_lines string

住所行。
市
 city string

住所の市 (区町村フィールドと組み合わせて使用しないでください)。
完了状態
 state string

住所の状態。
郵便番号
 postal_code string

住所の郵便番号。
区町村
 suburb string

住所の区町村 (市フィールドと組み合わせて使用しないでください)。
国
 county string

住所の郡。
情報元
 information_source string

住所の情報元。
リージョン
 region string

住所の地域。
CART
 cart string

住所の配送ルート (CART)。
LOT
 lot string

住所の移動ライン (LOT)。
DPC
 dpc string

住所の配送ポイント コード (DPC)。
有効開始日
 start date

スタッフがこの住所に居住し始めた日付 (例: '2005-09-18')。
有効最終日
 end date

スタッフがこの住所に居住しなくなった日付 (例: '2005-09-18')。
プライマリ?
 preferred boolean

これはスタッフの優先アドレスですか?
郵送不可?
 do_not_mail boolean

この住所でスタッフに連絡できますか?
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。

スタッフ基金調達者を一覧表示する

操作 ID:
ListConstituentFundraiserAssignments

スタッフの基金調達者割り当てを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
非アクティブを含む?
 include_inactive boolean

非アクティブな資金調達者の割り当てを含みますか？

戻り値

基金調達者の割り当て

本文​​
ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

スタッフ学歴を一覧表示する

操作 ID:
ListConstituentEducations

スタッフの学歴レコードを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

学歴

本文​​
ConstituentApi.ApiCollectionOfEducationRead

スタッフ学歴を更新する

操作 ID:
EditConstituentEducation

スタッフ学歴を更新します。

パラメーター

名前 キー 必須 型 説明
学歴 ID
 education_id True string

更新する学歴レコードのシステム レコード ID。
学校
 school string

学校/施設名。
タイプ
 type string

学歴の種類。
同期生
 class_of string

スタッフが卒業した年。
ステータス
 status string

学歴のステータス。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
学位
 degree string

終了した学位。
GPA
 gpa double

成績平均点。
研究のテーマ
 subject_of_study string

研究のテーマ。
プライマリ?
 primary boolean

これはスタッフのプライマリ学校協会ですか?
主専攻
 majors array of string

研究の専攻コース。
副専攻
 minors array of string

研究の副専攻コース。
キャンパス
 campus string

キャンパス。 文字数制限: 50。
社会組織
 social_organization string

社会組織。 文字数制限: 50。
既知の名前
 known_name string

既知の名前。 文字数制限: 50。
学位の種類
 class_of_degree string

学位の種類。
部署
 department string

学科の名前。
学部
 faculty string

学部の名前。
登録番号
 registration_number string

登録番号。 文字数制限: 50。

スタッフ教育を作成する

操作 ID:
CreateConstituentEducation

新しいスタッフ教育を作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

教育に関連付けられたスタッフのシステム レコード ID。
学校
 school True string

学校/施設名。
タイプ
 type string

学歴の種類。
同期生
 class_of string

スタッフが卒業した年。
ステータス
 status string

学歴のステータス。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
学位
 degree string

終了した学位。
GPA
 gpa double

成績平均点。
研究のテーマ
 subject_of_study string

研究のテーマ。
プライマリ?
 primary boolean

これはスタッフのプライマリ学校協会ですか?
主専攻
 majors array of string

研究の専攻コース。
副専攻
 minors array of string

研究の副専攻コース。
キャンパス
 campus string

キャンパス。 文字数制限: 50。
社会組織
 social_organization string

社会組織。 文字数制限: 50。
既知の名前
 known_name string

既知の名前。 文字数制限: 50。
学位の種類
 class_of_degree string

学位の種類 (英国バージョンにのみ適用可能)。
部署
 department string

学科の名前 (英国バージョンにのみ適用可能)。
学部
 faculty string

学部の名前 (英国バージョンにのみ適用可能)。
登録番号
 registration_number string

登録番号 (英国バージョンにのみ適用可能)。 文字数制限: 50。

戻り値

作成済みスタッフ教育

本文​​
ConstituentApi.CreatedConstituentEducation

スタッフ添付資料を一覧表示する

操作 ID:
ListConstituentAttachments

スタッフの添付資料を一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

Attachments

本文​​
ConstituentApi.ApiCollectionOfConstituentAttachmentRead

スタッフ添付資料を作成する

操作 ID:
CreateConstituentAttachment

新しいスタッフ添付資料を作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 parent_id True string

添付資料に関連付けられたスタッフのシステム レコード ID。
タイプ
 type True string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。 指定しない場合、このフィールドは既定で現在の日時になります。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。

戻り値

作成済みスタッフ添付資料

本文​​
ConstituentApi.CreatedConstituentAttachment

スタッフ添付資料を更新する

操作 ID:
EditConstituentAttachment

スタッフ添付資料を更新します。

パラメーター

名前 キー 必須 型 説明
添付ファイル ID
 attachment_id True string

更新する添付資料のシステム レコード ID。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。

スタッフ要請コードを作成する

操作 ID:
CreateConstituentSolicitCode

新しいスタッフ要請コードを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

要請コードに関連付けられたスタッフのシステム レコード ID。
要請コード
 solicit_code True string

スタッフに対する通信指示や制限。
開始日
 start_date date

要請コードの開始日 (例: '2005-09-18')。
終了日
 end_date date

要請コードの終了日 (例: '2005-09-18')。

戻り値

作成済みスタッフ要請コード

本文​​
CommPrefApi.CreatedConstituentSolicitCode

スタッフ要請コードを更新する

操作 ID:
EditConstituentSolicitCode

スタッフ要請コードを更新します。

パラメーター

名前 キー 必須 型 説明
要請コード ID
 constituent_solicit_code_id True string

更新する要請コードのシステム レコード ID。
要請コード
 solicit_code string

スタッフに対する通信指示や制限。
開始日
 start_date date

要請コードの開始日 (例: '2005-09-18')。
終了日
 end_date date

要請コードの終了日 (例: '2005-09-18')。

スタッフ関連付けを一覧表示する

操作 ID:
ListConstituentRelationships

スタッフの関連付けを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大数はありません。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。

戻り値

関係

本文​​
ConstituentApi.ApiCollectionOfRelationshipRead

スタッフ関連付けを更新する

操作 ID:
EditConstituentRelationship

スタッフの関連付けを更新します。 相互関係が存在する場合は、変更を反映するようにも変更されます。 これには、各レコードに固有であり、各レコードで個別に変更できる "コメント" プロパティへの変更は含まれません。

パラメーター

名前 キー 必須 型 説明
リレーションシップ ID
 relationship_id True string

更新するリレーションシップのシステム レコード ID。
タイプ
 type string

関連付けが表す関係の種類。
相互の種類
 reciprocal_type string

関連するスタッフとのスタッフ関連付けを説明します。 たとえば、男性スタッフと女性兄弟の関係では、相互関係の種類は兄弟になります。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
配偶者?
 is_spouse boolean

関連個人はスタッフの配偶者ですか (個人間のリレーションシップにのみ適用されます)?
スタッフは世帯主?
 is_constituent_head_of_household boolean

スタッフは世帯主ですか?
配偶者は世帯主?
 is_spouse_head_of_household boolean

配偶者は世帯主ですか?
メモ
comment string

関係についての追加メモ。
取引先担当者?
 is_organization_contact boolean

スタッフは取引先担当者としてこの組織を代表しますか (組織と個人間のリレーションシップにのみ適用されます)?
プライマリ事業?
 is_primary_business boolean

これはスタッフの主事業ですか (組織と個人間のリレーションシップにのみ適用されます)?
取引先担当者の種類
 organization_contact_type string

取引先担当者として組織を代表する関連個人との対話のコンテキストを提供します。 組織と個人間のリレーションシップにのみ適用されます。
位置
 position string

組織内での個人のポジション。 組織と個人間のリレーションシップにのみ適用されます。 文字数制限: 50。

ドキュメントの場所を作成する

操作 ID:
CreateDocument

物理的な添付資料で使用するために、新しい一意のドキュメント識別子とアップロード場所を作成します。 応答には、ドキュメントの内容をアップロードする場所および方法についての指示が含まれます。

パラメーター

名前 キー 必須 型 説明
ファイル名
 file_name string

アップロードするドキュメントのファイル名。
サムネイルを含む?
 upload_thumbnail boolean

サムネイル ドキュメントの場所を含めますか?

戻り値

ファイル定義

本文​​
ConstituentApi.FileDefinition

バッチにギフトを追加する

操作 ID:
AddGiftToBatch

指定したギフト バッチにギフトを追加します。

パラメーター

名前 キー 必須 型 説明
バッチ
 batch_id True string

ギフトを追加する対象のバッチ。
スタッフ ID
 constituent_id True string

ギフトに関連付けられたスタッフのシステム レコード ID。
金額
 value True double

ギフトの金額。
日
 date True date

贈与の日付 (例: '2020-09-18')。
タイプ
 type True string

ギフトの種類。
キャンペーン ID
 campaign_id string

贈与分割に関連付けられたキャンペーンのシステム レコード ID。
資金 ID
 fund_id True string

贈与分割に関連付けられた資金のシステム レコード ID。
異議申し立て ID
 appeal_id string

贈与分割に関連付けられた異議申し立てのシステム レコード ID。
パッケージ ID
 package_id string

贈与分割に関連付けられたパッケージのシステム レコード ID。
金額
 value True double

贈与分割の金額。
支払方法
 payment_method True string

支払方法。
小切手番号
 check_number string

小切手番号 (支払方法が "個人的小切手" の場合のみ適用されます)。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
参照
 reference string

支払参照 (支払方法が "その他" の場合のみ適用されます)。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
匿名かどうか
 is_anonymous boolean

匿名贈与かどうか 値を指定しない場合は、既定の寄付者の匿名性を使用します。
サブタイプ
 subtype string

ギフトのサブタイプ。
コメント
 reference string

ギフトに関する特別な情報 (ギフトに対するモチベーションや、現物ギフトの詳しい説明など) を追跡するメモです。
検索 ID
 lookup_id string

このギフトのユーザーが定義した識別子。
基金調達者クレジットを使用しますか?
 default_fundraiser_credits boolean

既定の基金調達者クレジットを使用しますか?
ソフト クレジットを使用しますか?
 default_soft_credits boolean

既定のソフト クレジットを使用しますか?
購買者層
 constituency string

ギフトの購買者層。
転記の状態
 post_status string

贈与の転記の状態。
転記日
 post_date date

贈与の転記日 (例: '2020-09-18')。
領収書の状態
 status True string

贈与の領収書の状態。
領収書の金額
 value True double

ギフトの領収書の金額。
受領日
 date date

贈与を受け取った日付です (例: '2020-09-18')。

戻り値

バッチ ギフト エラー レコードのコレクションと、この操作で追加したバッチ ギフトを含みます

結果​​
GiftApi.BatchGiftAddResults

パッケージを一覧表示する

操作 ID:
ListPackages

パッケージの一覧を返します。

パラメーター

名前 キー 必須 型 説明
訴求力 ID
 appeal_id string

結果をフィルタリングする異議申し立て識別子のコンマ区切り一覧を表します。 たとえば、"506,918" は、異議申し立て 506 または異議申し立て 918 のパッケージのみを返します。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。
非アクティブを含む?
 include_inactive boolean

非アクティブなパッケージを含みますか?
以降に追加済
 date_added date-time

指定した日付以降に作成されたパッケージに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。
以降に修正済
 last_modified date-time

指定した日付以降に修正されたパッケージに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。

戻り値

パッケージ

本文​​
FundraisingApi.ApiCollectionOfPackageRead

パッケージを取得する

操作 ID:
GetPackage

パッケージに関する情報を返します。

パラメーター

名前 キー 必須 型 説明
パッケージ ID
 package_id True string

取得するパッケージのシステム レコード ID。

戻り値

パッケージ

本文​​
FundraisingApi.PackageRead

レコード セットからリストを作成する

操作 ID:
CreateListFromIDs

指定したレコード セットをフィルターして新しいリストを作成します。

パラメーター

名前 キー 必須 型 説明
件名
 name True string

一覧の名前。 文字数制限: 50。
内容
 description True string

リストの説明。
一覧の種類
 list_type True string

作成するリストの種類を指定します。
Permissions
 list_permissions True string

このリストに他のユーザーがアクセスできるかどうかを指定します。
ID
 ids True array of string

リストに含まれるレコードを表す一意識別子 (最大 100,000 件の値)。

戻り値

作成したリスト

Body
ListApi.CreatedList

レコードをリストに追加する

操作 ID:
AppendIDsToList

レコード セットを既存のリストに追加します。

パラメーター

名前 キー 必須 型 説明
一覧の種類
 list_type True string

リストの種類。
リスト
 list_id True string

リストのシステム レコード ID。
ID
 ids True array of string

リストに追加するレコードを表す一意識別子 (最大 100,000 件の値)。

個々のスタッフを作成する

操作 ID:
CreateIndividualConstituent

新しい個々のスタッフを作成します。

パラメーター

名前 キー 必須 型 説明
敬称
 title string

スタッフの主な役職。
名
 first string

スタッフの名。 文字数制限: 50。
姓
 last True string

スタッフの姓。 文字数制限: 100。
敬称
 suffix string

スタッフの主な敬称。
検索 ID
 lookup_id string

スタッフのユーザー定義した識別子。
種類
 type True string

住所の種類。
country
 country string

住所の国 (ID、名前、または略語形の場合があります)。
行数
 address_lines string

住所行。 文字数制限: 150。
city
 city string

住所の市 (区町村フィールドと組み合わせて使用しないでください)。
状態
 state string

住所の状態。
郵便番号
 postal_code string

住所の郵便番号。 文字数制限: 12。
区町村
 suburb string

住所の区町村 (市フィールドと組み合わせて使用しないでください)。
county
 county string

住所の郡。
開始
 start date

スタッフがこの住所に居住し始めた日付 (例: '2005-09-18')。
終了
 end date

スタッフがこの住所に居住しなくなった日付 (例: '2005-09-18')。
種類
 type True string

電話番号の種類。
数値
 number True string

電話番号。
プライマリ?
 primary boolean

これはスタッフの優先電話番号ですか?
種類
 type True string

電子メール アドレスの種類。
アドレス
 address True string

電子メール アドレス。
プライマリ?
 primary boolean

これはスタッフの優先電子メール アドレスですか?
種類
 type True string

オンライン プレゼンスの種類。
アドレス
 address True string

オンライン プレゼンスの Web アドレス。
プライマリ?
 primary boolean

これはスタッフの優先オンライン プレゼンスですか?
希望する名前
 preferred_name string

スタッフの優先名。 文字数制限: 50。
ミドルネーム
 middle string

スタッフのミドル ネーム。 文字数制限: 50。
旧名
 former_name string

スタッフの旧名。 文字数制限: 100。
役職 2
 title_2 string

スタッフのセカンダリ役職。
敬称 2
 suffix_2 string

スタッフのセカンダリ敬称。
性別
 gender string

スタッフの性別。
婚姻区分
 marital_status string

スタッフの婚姻区分。
匿名?
 gives_anonymously boolean

スタッフは匿名ですか?
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
出生地
 birthplace string

スタッフの出生地。
民族
 ethnicity string

スタッフの民族。
収益
 income string

スタッフの収入。
宗教
 religion string

スタッフの宗教。
カスタム宛先?
 custom_format boolean

プライマリ宛先はカスタム形式ですか?
宛先の形式
 configuration_id string

プライマリ宛先の構成 (カスタム形式が使用されていない限り必須)。
宛先のカスタム名
 formatted_name string

プライマリ宛先の書式設定された名前 (カスタム形式が使用される場合に必須)。 文字数制限: 255。
カスタム挨拶?
 custom_format boolean

プライマリ挨拶はカスタム形式ですか?
挨拶の形式
 configuration_id string

プライマリ挨拶の構成 (カスタム形式が使用されていない限り必須)。
挨拶のカスタム名
 formatted_name string

プライマリ挨拶の書式設定された名前 (カスタム形式が使用される場合に必須)。 文字数制限: 255。

戻り値

作成済み個々のスタッフ

本文​​
ConstituentApi.CreatedIndividualConstituent

個々の関連付けを作成する

操作 ID:
CreateIndividualRelationship

新しい関連付けを作成します。 別のスタッフとの関連付けである場合、そのスタッフに対して相互関係が作成されます。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

関連付けに関連付けられたスタッフのシステム レコード ID。
関係 ID
 relation_id True string

関連する個人のシステム レコード ID。
タイプ
 type string

関連付けが表す関係の種類。
相互の種類
 reciprocal_type string

関連するスタッフとのスタッフ関連付けを説明します。 たとえば、男性スタッフと女性兄弟の関係では、相互関係の種類は兄弟になります。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
配偶者?
 is_spouse boolean

関連する個人はスタッフの配偶者ですか?
スタッフは世帯主?
 is_constituent_head_of_household boolean

スタッフは世帯主ですか?
配偶者は世帯主?
 is_spouse_head_of_household boolean

配偶者は世帯主ですか?
メモ
comment string

関係についての追加メモ。

戻り値

作成済み個々の関係

本文​​
ConstituentApi.CreatedIndividualRelationship

参加者の寄付を一覧で表示する

操作 ID:
ListParticipantDonations

参加者の寄付を一覧で表示します。

パラメーター

名前 キー 必須 型 説明
参加者 ID
 participant_id True string

参加者のシステム レコード ID。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 10000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。 既定値は 0 です。

戻り値

寄付

本文​​
EventApi.ApiCollectionOfParticipantDonation

参加者の寄付を作成する

操作 ID:
CreateParticipantDonation

参加者の新しい寄付を作成します。

パラメーター

名前 キー 必須 型 説明
参加者 ID
 participant_id True string

参加者のシステム レコード ID。
ギフト ID
 gift_id True string

参加者の寄付をリンクしたギフトのシステム レコード ID。

戻り値

参加者の寄付を作成する

本文​​
EventApi.CreatedParticipantDonation

参加者の手数料を一覧表示する

操作 ID:
ListParticipantFees

参加者の手数料を一覧表示します。

パラメーター

名前 キー 必須 型 説明
参加者 ID
 participant_id True string

参加者のシステム レコード ID。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 10000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。 既定値は 0 です。

戻り値

手数料

本文​​
EventApi.ApiCollectionOfParticipantFee

参加者の手数料支払を一覧表示する

操作 ID:
ListParticipantFeePayments

参加者の手数料支払を一覧表示します。

パラメーター

名前 キー 必須 型 説明
参加者 ID
 participant_id True string

参加者のシステム レコード ID。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 10000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。 既定値は 0 です。

戻り値

手数料支払

本文​​
EventApi.ApiCollectionOfParticipantFeePayment

参加者の手数料支払を作成する

操作 ID:
CreateParticipantFeePayment

参加者の新しい手数料支払を作成します。

パラメーター

名前 キー 必須 型 説明
参加者 ID
 participant_id True string

参加者のシステム レコード ID。
ギフト ID
 gift_id True string

参加者費用をリンクしたギフトのシステム レコード ID。
適用済み金額
 applied_amount True double

参加者費用に適用される支払い額。

戻り値

作成済み参加者の手数料支払

本文​​
EventApi.CreatedParticipantFeePayment

参加者を作成する

操作 ID:
CreateParticipant

イベントの新しい参加者を作成します。

パラメーター

名前 キー 必須 型 説明
イベント ID
 event_id True string

イベントのシステム レコード ID。
スタッフ ID
 constituent_id True string

参加者のスタッフ ID。
ホスト ID
 host_id string

ホストの参加者レコードの ID。
RSVP ステータス
 rsvp_status string

参加者のイベントへのエンゲージメントのステータス。
参加済?
 attended boolean

参加者はイベントに参加しましたか?
招待の状態
 invitation_status string

参加者への招待のステータス。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
参加レベル
 name True string

参加レベルの名前。

戻り値

作成済み参加者

本文​​
EventApi.CreatedParticipant

参加者を取得する

操作 ID:
GetParticipant

特定のイベント参加者に関する情報を返します。

パラメーター

名前 キー 必須 型 説明
参加者 ID
 participant_id True string

参加者のシステム レコード ID。

戻り値

関係者

本文​​
EventApi.Participant

参加者を更新する

操作 ID:
EditParticipant

参加者に関する詳細を更新します。

パラメーター

名前 キー 必須 型 説明
参加者 ID
 participant_id True string

更新する参加者のシステム レコード ID。
スタッフ ID
 constituent_id string

参加者のスタッフ ID。
ホスト ID
 host_id string

ホストの参加者レコードの ID。
RSVP ステータス
 rsvp_status string

参加者のイベントへのエンゲージメントのステータス。
参加済?
 attended boolean

参加者はイベントに参加しましたか?
招待の状態
 invitation_status string

参加者への招待のステータス。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
参加レベル
 name True string

参加レベルの名前。

参加者オプションを一覧表示する

操作 ID:
ListParticipantOptions

参加者の参加者オプションを一覧表示します。

パラメーター

名前 キー 必須 型 説明
参加者 ID
 participant_id True string

参加者のシステム レコード ID。

戻り値

参加者オプション

本文​​
EventApi.ApiCollectionOfParticipantOption

参加者オプションを作成する

操作 ID:
CreateParticipantOption

参加者の新しい参加者オプションを作成します。

パラメーター

名前 キー 必須 型 説明
参加者 ID
 participant_id True string

参加者の ID。
本文
 body True dynamic

作成する参加者オプションを表すオブジェクト。

戻り値

作成済み参加者オプション

本文​​
EventApi.CreatedParticipantOption

参加者オプションを更新する

操作 ID:
EditParticipantOption

参加者オプションに関する詳細を更新します。

パラメーター

名前 キー 必須 型 説明
参加者オプション ID
 option_id True string

更新する参加者オプションのシステム レコード ID。
値
 option_value True string

オプションに対する参加者の応答。

参加者費用を作成する

操作 ID:
CreateParticipantFee

参加者の新しい費用を作成します。

パラメーター

名前 キー 必須 型 説明
参加者 ID
 participant_id True string

参加者のシステム レコード ID。
イベント ID
 event_id True string

イベントのシステム レコード ID。
料金
 event_fee_id True string

イベント料金。
数量
 quantity True integer

購入済みの数量。
手数料金額
 fee_amount True double

手数料に関連する金額。
寄付額
 contribution_amount True double

イベントの費用を超える寄付金の金額。 これは通常、領収書に表示される金額です。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。

戻り値

作成済み参加者費用

本文​​
EventApi.CreatedParticipantFee

営業案件の添付資料を一覧表示する

操作 ID:
ListOpportunityAttachments

営業案件の添付資料を一覧表示します。

パラメーター

名前 キー 必須 型 説明
営業案件 ID
 opportunity_id True string

営業案件のシステム レコード ID。

戻り値

Attachments

本文​​
OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

営業案件の添付資料を作成する

操作 ID:
CreateOpportunityAttachment

新しい営業案件の添付資料を作成します。

パラメーター

名前 キー 必須 型 説明
営業案件 ID
 parent_id True string

添付資料に関連付けられた営業案件のシステム レコード ID。
タイプ
 type True string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。 指定しない場合、このフィールドは既定で現在の日時になります。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。

戻り値

作成済み営業案件の添付資料

本文​​
OpportunityApi.CreatedOpportunityAttachment

営業案件の添付資料を更新する

操作 ID:
EditOpportunityAttachment

営業案件の添付資料を更新します。

パラメーター

名前 キー 必須 型 説明
添付ファイル ID
 attachment_id True string

更新する添付資料のシステム レコード ID。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。

営業案件を一覧表示する

操作 ID:
ListOpportunities

営業案件の一覧を返します。

パラメーター

名前 キー 必須 型 説明
一覧取得
 list_id string

指定された一覧に含まれる一連の営業案件をフィルタリングするために使用される一覧識別子を定義します。 この値が設定されている場合、他の指定されたフィルターは無視されます。
スタッフ ID
 constituent_id string

結果をフィルタリングするスタッフ識別子のコンマ区切り一覧を表します。 たとえば、"280,1232" はスタッフ 280 またはスタッフ 1232 からの営業案件のみを返します。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。
非アクティブを含む?
 include_inactive boolean

アクティブな営業案件を含みますか?
以降に追加済
 date_added date-time

指定した日付以降に作成された営業案件に結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。
以降に修正済
 last_modified date-time

指定した日付以降に修正された営業案件に結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。

戻り値

営業案件

本文​​
OpportunityApi.ApiCollectionOfOpportunityRead

営業案件を作成する

操作 ID:
CreateOpportunity

新しい営業案件を作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

営業案件に関連付けられたスタッフのシステム レコード ID。
目的
 purpose True string

営業案件の結果として調達された任意の金額の使用目的。
件名
 name True string

一覧やスタッフ レコードなど、プログラム全体で営業案件を識別する名前。 文字数制限: 255。
ステータス
 status string

営業案件が要請処理のどこにあるかを示すステータス。
期日
 deadline date-time

ギフトにつながる営業案件の目標日 (例: '2020-09-18T04:13:56Z')。
依頼日
 ask_date date-time

要請の実行日 (例: '2020-09-18T04:13:56Z')。
値
 value double

金額。
予定日
 expected_date date-time

見込顧客が営業案件に応じて提供する予定の日付 (例: '2020-09-18T04:13:56Z')。
値
 value double

金額。
出資提供日
 funded_date date-time

見込顧客が営業案件に応じて提供した日付 (例: '2020-09-18T04:13:56Z')。
値
 value double

金額。
キャンペーン ID
 campaign_id string

営業案件に関連付けられたキャンペーンのシステム レコード ID。 キャンペーンでは、資金調達の全体的な目標を設定します。
資金 ID
 fund_id string

営業案件に関連付けられた資金のシステム レコード ID。 資金は、ギフトの特定の財務目的を指定し、そのギフトの財務勘定を識別します。
スタッフ ID
 constituent_id string

基金調達者に関連付けられたスタッフのシステム レコード ID。
値
 value double

金額。
非アクティブ?
 inactive boolean

営業案件は非アクティブですか?

戻り値

作成済み営業案件

本文​​
OpportunityApi.CreatedOpportunity

営業案件を取得する

操作 ID:
GetOpportunity

営業案件に関する情報を返します。 注: このエンドポイントは、約 10 分の遅延という状態プロパティを返します。

パラメーター

名前 キー 必須 型 説明
営業案件 ID
 opportunity_id True string

取得する営業案件のシステム レコード ID。

戻り値

営業案件​​

本文​​
OpportunityApi.OpportunityRead

営業案件を更新する

操作 ID:
EditOpportunity

営業案件を更新します。

パラメーター

名前 キー 必須 型 説明
営業案件 ID
 opportunity_id True string

更新する営業案件のシステム レコード ID。
目的
 purpose string

営業案件の結果として調達された任意の金額の使用目的。
件名
 name string

一覧やスタッフ レコードなど、プログラム全体で営業案件を識別する名前。 文字数制限: 255。
ステータス
 status string

営業案件が要請処理のどこにあるかを示すステータス。
期日
 deadline date-time

ギフトにつながる営業案件の目標日 (例: '2020-09-18T04:13:56Z')。
依頼日
 ask_date date-time

要請の実行日 (例: '2020-09-18T04:13:56Z')。
値
 value double

金額。
予定日
 expected_date date-time

見込顧客が営業案件に応じて提供する予定の日付 (例: '2020-09-18T04:13:56Z')。
値
 value double

金額。
出資提供日
 funded_date date-time

見込顧客が営業案件に応じて提供した日付 (例: '2020-09-18T04:13:56Z')。
値
 value double

金額。
キャンペーン ID
 campaign_id string

営業案件に関連付けられたキャンペーンのシステム レコード ID。 キャンペーンでは、資金調達の全体的な目標を設定します。
資金 ID
 fund_id string

営業案件に関連付けられた資金のシステム レコード ID。 資金は、ギフトの特定の財務目的を指定し、そのギフトの財務勘定を識別します。
スタッフ ID
 constituent_id string

基金調達者に関連付けられたスタッフのシステム レコード ID。
値
 value double

金額。
非アクティブ?
 inactive boolean

営業案件は非アクティブですか?

営業案件カスタム フィールドを一覧表示する

操作 ID:
ListOpportunityCustomFields

営業案件のカスタム フィールドを一覧表示します。

パラメーター

名前 キー 必須 型 説明
営業案件 ID
 opportunity_id True string

営業案件のシステム レコード ID。

戻り値

カスタム フィールド

本文​​
OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

営業案件カスタム フィールドを作成する

操作 ID:
CreateOpportunityCustomField

新しい営業案件カスタム フィールドを作成します。

パラメーター

名前 キー 必須 型 説明
本文
 body True dynamic

作成するカスタム フィールドを表すオブジェクト。

戻り値

作成済み営業案件の添付資料

本文​​
OpportunityApi.CreatedOpportunityCustomField

営業案件カスタム フィールドを更新する

操作 ID:
EditOpportunityCustomField

営業案件カスタム フィールドを更新します。

パラメーター

名前 キー 必須 型 説明
カスタム フィールド ID
 custom_field_id True string

更新するカスタム フィールドのシステム レコード ID。
本文
 body True dynamic

更新するカスタム フィールドのプロパティを表すオブジェクト。

基金調達者の割り当てを一覧で表示する

操作 ID:
ListFundraiserAssignments

基金調達者の割り当てを一覧で表示します。

パラメーター

名前 キー 必須 型 説明
基金調達者 ID
 fundraiser_id True string

割り当てを返す対象の基金調達者を表すシステム レコード ID。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。

戻り値

割り当て

本文​​
FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

基金調達者の割り当てを作成する

操作 ID:
CreateFundraiserAssignment

新しい基金調達者の割り当てを作成します。

パラメーター

名前 キー 必須 型 説明
基金調達者 ID
 fundraiser_id True string

基金調達者のシステム レコード ID。
スタッフ ID
 constituent_id True string

割り当て済みスタッフのシステム レコード ID。
タイプ
 type string

基金調達者の種類。
割り当て開始
 start date-time

割り当ての開始日。
割り当て終了
 end date-time

割り当ての終了日。
金額
 value True double

割り当て済みスタッフから募る資金調達の目標金額。
キャンペーン ID
 campaign_id string

ギフトを適用することになる、キャンペーン対象のシステム レコード ID。
資金 ID
 fund_id string

ギフトを適用することになる、資金対象のシステム レコード ID。
訴求力 ID
 appeal_id string

ギフトを適用することになる、異議申し立てのシステム レコード ID。

戻り値

作成した基金調達者の割り当て

本文​​
FundraisingApi.CreatedFundraiserAssignment

異議申し立てを一覧表示する

操作 ID:
ListAppeals

異議申し立ての一覧を返します。

パラメーター

名前 キー 必須 型 説明
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。
非アクティブを含む?
 include_inactive boolean

非アクティブな異議申し立てを含みますか?
以降に追加済
 date_added date-time

指定した日付以降に作成された異議申し立てに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。
以降に修正済
 last_modified date-time

指定した日付以降に修正された異議申し立てに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。

戻り値

異議申し立て

本文​​
FundraisingApi.ApiCollectionOfAppealRead

異議申し立てを取得する

操作 ID:
GetAppeal

異議申し立てに関する情報を返します。

パラメーター

名前 キー 必須 型 説明
訴求力 ID
 appeal_id True string

取得する異議申し立てのシステム レコード ID。

戻り値

異議申し立て

本文​​
FundraisingApi.AppealRead

異議申し立てカスタム フィールドを一覧表示する

操作 ID:
ListAppealCustomFields

異議申し立てのカスタム フィールドを一覧表示します。

パラメーター

名前 キー 必須 型 説明
訴求力 ID
 appeal_id True string

異議申し立てのシステム レコード ID。

戻り値

カスタム フィールド

本文​​
FundraisingApi.ApiCollectionOfAppealCustomFieldRead

異議申し立てカスタム フィールドを作成する

操作 ID:
CreateAppealCustomField

新しい異議申し立てカスタム フィールドを作成します。

パラメーター

名前 キー 必須 型 説明
本文
 body True dynamic

作成するカスタム フィールドを表すオブジェクト。

戻り値

作成済み異議申し立てカスタム フィールド

本文​​
FundraisingApi.CreatedAppealCustomField

異議申し立てカスタム フィールドを更新する

操作 ID:
EditAppealCustomField

異議申し立てカスタム フィールドを更新します。

パラメーター

名前 キー 必須 型 説明
カスタム フィールド ID
 custom_field_id True string

更新するカスタム フィールドのシステム レコード ID。
本文
 body True dynamic

更新するカスタム フィールドのプロパティを表すオブジェクト。

異議申し立て添付資料を一覧表示する

操作 ID:
ListAppealAttachments

異議申し立ての添付資料を一覧表示します。

パラメーター

名前 キー 必須 型 説明
訴求力 ID
 appeal_id True string

異議申し立てのシステム レコード ID。

戻り値

Attachments

本文​​
FundraisingApi.ApiCollectionOfAppealAttachmentRead

異議申し立て添付資料を作成する

操作 ID:
CreateAppealAttachment

新しい異議申し立て添付資料を作成します。

パラメーター

名前 キー 必須 型 説明
訴求力 ID
 parent_id True string

添付資料に関連付けられた異議申し立てのシステム レコード ID。
タイプ
 type True string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。 指定しない場合、このフィールドは既定で現在の日時になります。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。

戻り値

作成済み異議申し立て添付資料

本文​​
FundraisingApi.CreatedAppealAttachment

異議申し立て添付資料を更新する

操作 ID:
EditAppealAttachment

異議申し立て添付資料を更新します。

パラメーター

名前 キー 必須 型 説明
添付ファイル ID
 attachment_id True string

更新する添付資料のシステム レコード ID。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。

組織の関連付けを作成する

操作 ID:
CreateOrganizationRelationship

新しい組織の関連付けを作成します。 別のスタッフとの関連付けである場合、そのスタッフに対して相互関係が作成されます。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

関連付けに関連付けられたスタッフのシステム レコード ID。
関係 ID
 relation_id True string

関連する組織のシステム レコード ID。
タイプ
 type string

関連付けが表す関係の種類。
相互の種類
 reciprocal_type string

関連する組織とのスタッフ関連付けを説明します。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
取引先担当者?
 is_organization_contact boolean

スタッフは取引先担当者としてこの組織を代表しますか？
取引先担当者の種類
 organization_contact_type string

取引先担当者として組織を代表する関連個人との対話のコンテキストを提供します。
位置
 position string

組織内での個人のポジション。 文字数制限: 50。
プライマリ事業?
 is_primary_business boolean

これはスタッフのプライマリ事業ですか?
メモ
comment string

関係についての追加メモ。

戻り値

作成済み組織の関連付け

本文​​
ConstituentApi.CreatedOrganizationRelationship

組織スタッフを作成する

操作 ID:
CreateOrganizationConstituent

新しい組織スタッフを作成します。

パラメーター

名前 キー 必須 型 説明
件名
 name True string

組織名。 文字数制限: 100。
検索 ID
 lookup_id string

スタッフのユーザー定義した識別子。
種類
 type True string

住所の種類。
country
 country string

住所の国 (ID、名前、または略語形の場合があります)。
行数
 address_lines string

住所行。 文字数制限: 150。
city
 city string

住所の市 (区町村フィールドと組み合わせて使用しないでください)。
状態
 state string

住所の状態。
郵便番号
 postal_code string

住所の郵便番号。 文字数制限: 12。
区町村
 suburb string

住所の区町村 (市フィールドと組み合わせて使用しないでください)。
county
 county string

住所の郡。
開始
 start date

スタッフがこの住所に居住し始めた日付 (例: '2005-09-18')。
終了
 end date

スタッフがこの住所に居住しなくなった日付 (例: '2005-09-18')。
種類
 type True string

電話番号の種類。
数値
 number True string

電話番号。
プライマリ?
 primary boolean

これはスタッフの優先電話番号ですか?
種類
 type True string

電子メール アドレスの種類。
アドレス
 address True string

電子メール アドレス。
プライマリ?
 primary boolean

これはスタッフの優先電子メール アドレスですか?
種類
 type True string

オンライン プレゼンスの種類。
アドレス
 address True string

オンライン プレゼンスの Web アドレス。
プライマリ?
 primary boolean

これはスタッフの優先オンライン プレゼンスですか?
匿名?
 gives_anonymously boolean

スタッフは匿名ですか?
業種
 industry string

スタッフの業種。
従業員数
 num_employees integer

組織の従業員数。
ギフトと一致?
 matches_gifts boolean

組織はギフトと一致していますか?
一致するギフト要素
 matching_gift_factor double

一致するギフト要素。
ギフトあたりの最小一致
 value double

スタッフのギフトあたりの最小一致額。
ギフトあたりの最大一致
 value double

スタッフのギフトあたりの最大一致額。
スタッフあたりの最小一致
 value double

スタッフの最小一致の合計。
スタッフあたりの最大一致
 value double

スタッフの最大一致の合計。
一致するギフト メモ
 matching_gift_notes string

スタッフに一致するギフト メモ。

戻り値

作成済み組織スタッフ

本文​​
ConstituentApi.CreatedOrganizationConstituent

要請コードを一覧表示する

操作 ID:
ListConstituentSolicitCodes

スタッフの要請コードを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

要請コード

本文​​
CommPrefApi.ConstituentSolicitCodeReadCollection

資金のカスタム フィールドを作成する

操作 ID:
CreateFundCustomField

新しい資金のカスタム フィールドを作成します。

パラメーター

名前 キー 必須 型 説明
本文
 body True dynamic

作成するカスタム フィールドを表すオブジェクト。

戻り値

作成済み資金のカスタム フィールド

本文​​
FundraisingApi.CreatedFundCustomField

資金のカスタム フィールドを更新する

操作 ID:
EditFundCustomField

資金のカスタム フィールドを更新します。

パラメーター

名前 キー 必須 型 説明
カスタム フィールド ID
 custom_field_id True string

更新するカスタム フィールドのシステム レコード ID。
本文
 body True dynamic

更新するカスタム フィールドのプロパティを表すオブジェクト。

資金の添付資料を一覧表示する

操作 ID:
ListFundAttachments

資金の添付資料を一覧表示します。

パラメーター

名前 キー 必須 型 説明
資金 ID
 fund_id True string

資金のシステム レコード ID。

戻り値

Attachments

本文​​
FundraisingApi.ApiCollectionOfFundAttachmentRead

資金の添付資料を作成する

操作 ID:
CreateFundAttachment

新しい資金の添付資料を作成します。

パラメーター

名前 キー 必須 型 説明
資金 ID
 parent_id True string

添付資料に関連付けられた資金のシステム レコード ID。
タイプ
 type True string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。 指定しない場合、このフィールドは既定で現在の日時になります。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。

戻り値

作成済み資金の添付資料

本文​​
FundraisingApi.CreatedFundAttachment

資金の添付資料を更新する

操作 ID:
EditFundAttachment

資金の添付資料を更新します。

パラメーター

名前 キー 必須 型 説明
添付ファイル ID
 attachment_id True string

更新する添付資料のシステム レコード ID。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。

資金を一覧表示する

操作 ID:
ListFunds

資金の一覧を返します。

パラメーター

名前 キー 必須 型 説明
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。
非アクティブを含む?
 include_inactive boolean

非アクティブな資金を含みますか?
以降に追加済
 date_added date-time

指定した日付以降に作成された資金に結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。
以降に修正済
 last_modified date-time

指定した日付以降に修正された資金に結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。

戻り値

資金

本文​​
FundraisingApi.ApiCollectionOfFundRead

資金を取得する

操作 ID:
GetFund

資金に関する情報を返します。

パラメーター

名前 キー 必須 型 説明
資金 ID
 fund_id True string

取得する資金のシステム レコード ID。

戻り値

資金

本文​​
FundraisingApi.FundRead

資金カスタム フィールドを一覧表示する

操作 ID:
ListFundCustomFields

資金のカスタム フィールドを一覧表示します。

パラメーター

名前 キー 必須 型 説明
資金 ID
 fund_id True string

資金のシステム レコード ID。

戻り値

カスタム フィールド

本文​​
FundraisingApi.ApiCollectionOfFundCustomFieldRead

定義

CommPrefApi.ConstituentConsentRead

スタッフの同意エンティティを表します。

名前 パス 型 説明
ID
 id string

同意レコードのシステム レコード ID。
チャネル
 channel string

同意応答が適用されるチャネル。
カテゴリ
 category string

同意応答が適用されるカテゴリ。
ソース
 source string

スタッフからの同意応答のソース。
回答
 constituent_consent_response string

指定されたチャネル/カテゴリの同意に対するスタッフの応答方法。
日
 consent_date date-time

同意応答が受信された日付。
同意書
 consent_statement string

同意時にスタッフが応答したステートメント。
プライバシー通知
 privacy_notice string

スタッフに提供されるプライバシーに関する声明。
追加した日付
 date_added date-time

同意応答が追加された日付。
追加者
 user_name string

同意応答を追加したユーザー。

CommPrefApi.ConstituentConsentReadCollection

同意レコード

名前 パス 型 説明
カウント
 count integer

一覧内の同意レコードの数。
値
 value array of CommPrefApi.ConstituentConsentRead

応答に含まれる一連の同意レコード。

CommPrefApi.ConstituentSolicitCodeRead

要請コード

名前 パス 型 説明
ID
 id string

スタッフ要請コードのシステム レコード ID。
要請コード
 solicit_code string

スタッフに対する通信指示や制限。
開始日
 start_date date

要請コードの開始日 (例: '2005-09-18')。
終了日
 end_date date

要請コードの終了日 (例: '2005-09-18')。

CommPrefApi.ConstituentSolicitCodeReadCollection

要請コード

名前 パス 型 説明
カウント
 count integer

一覧内のスタッフ要請コードの数。
値
 value array of CommPrefApi.ConstituentSolicitCodeRead

応答に含まれる一連のスタッフ要請コード。

CommPrefApi.CreatedConstituentConsent

作成済みスタッフ同意

名前 パス 型 説明
ID
 id string

新しく作成された同意レコードの ID。

CommPrefApi.CreatedConstituentSolicitCode

作成済みスタッフ要請コード

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ要請コードの ID。

ConstituentApi.ActionAttachmentRead

添付

名前 パス 型 説明
ID
 id string

添付資料のシステム レコード ID。
アクション ID
 parent_id string

添付資料に関連付けられたアクションのシステム レコード ID。
タイプ
 type string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル URL
 thumbnail_url string

サムネイルの URL。 画像のみの物理的な添付資料の場合。 アクセスを 60 分に制限する、時間期限付きの署名が含まれます。
コンテンツ タイプ
 content_type string

コンテンツの種類。 物理的な添付資料のみ。
ファイル サイズ
 file_size integer

ファイル サイズ (バイト数)。 物理的な添付資料のみ。

ConstituentApi.ActionCustomFieldRead

カスタム フィールド

名前 パス 型 説明
ID
 id string

カスタム フィールドのシステム レコード ID。
アクション ID
 parent_id string

カスタム フィールドに関連付けられたアクションのシステム レコード ID。
カテゴリ
 category string

カスタム フィールド カテゴリ。
タイプ
 type string

カスタム フィールドが表すデータの種類。
値
 value

カスタム フィールドの値。
日
 date date

カスタム フィールドの日付。
コメント
 comment string

カスタム フィールドのコメント。 文字数制限: 50。
追加した日付
 date_added date-time

カスタム フィールドが作成された日付。
変更日
 date_modified date-time

カスタム フィールドが最終変更された日付。

ConstituentApi.ActionRead

操作​​

名前 パス 型 説明
ID
 id string

アクションのシステム レコード ID。
スタッフ ID
 constituent_id string

アクションに関連付けられたスタッフのシステム レコード ID。
カテゴリ
 category string

スタッフ対話のチャネルまたは意図。
完了済?
 completed boolean

アクションは完了しましたか? システムがカスタム アクションの状態を使用するように構成されている場合、この値はアクションの状態値に基づいています。
完了日
 completed_date date-time

アクションが完了した日付。
日
 date date-time

アクティブの日付。
メモ
description string

アクションの概要を詳しく述べる詳細説明。
通信方向
 direction string

アクションの方向。
基金調達者
 fundraisers array of string

アクションに関連付けられた基金調達者に対する一連のシステム レコード ID。
場所
 location string

アクションの場所。
営業案件 ID
 opportunity_id string

アクションに関連付けられた営業案件のシステム レコード ID。
結果
 outcome string

アクションの結果。
優先順位
 priority string

アクションの優先度。
開始時刻
 start_time string

アクションの開始時間。 HH:mm 形式で 24 時間制を使用します。
終了時刻
 end_time string

アクションの終了時間。 HH:mm 形式で 24 時間制を使用します。
ステータス
 status string

アクションの状態。
状態コード
 status_code string

アクション状態コード。 このプロパティは、システムがカスタム アクション状態を使用するように構成されている場合にのみ返されます。
計算されたステータス
 computed_status string

計算されたアクション状態。 システムがカスタム アクション状態を使用するように構成されていない場合、このフィールドは完了プロパティと日付プロパティに基づいてステータスを計算します。 そうでない場合は、フィールドは、アクションの日付プロパティと、アクションのアクション状態プロパティが完了済みとして構成されているかどうかに基づいてステータスを計算します。
サマリー
 summary string

レコードの上部に表示されるアクションの簡単な説明。 文字数制限: 255。
タイプ
 type string

カテゴリを補完するアクションの追加説明。
追加した日付
 date_added date-time

アクションが作成された日付。
変更日
 date_modified date-time

アクションが最終変更された日付。

ConstituentApi.AddressRead

住所

名前 パス 型 説明
ID
 id string

住所のシステム レコード ID。
タイプ
 type string

住所の種類。
国
 country string

住所の国 (ID、名前、または略語形の場合があります)。
住所行
 address_lines string

住所行。
市
 city string

住所の市 (区町村フィールドと組み合わせて使用しないでください)。
完了状態
 state string

住所の状態。
郵便番号
 postal_code string

住所の郵便番号。
区町村
 suburb string

住所の区町村 (市フィールドと組み合わせて使用しないでください)。
国
 county string

住所の郡。
書式設定された住所
 formatted_address string

国の構成済み形式で書式設定された住所。
情報元
 information_source string

住所の情報元。
リージョン
 region string

住所の地域。
CART
 cart string

住所の配送ルート (CART)。
LOT
 lot string

住所の移動ライン (LOT)。
DPC
 dpc string

住所の配送ポイント コード (DPC)。
有効開始日
 start date-time

スタッフがこの住所に居住し始めた日付。
有効最終日
 end date-time

スタッフがこの住所に居住しなくなった日付。
プライマリ?
 preferred boolean

これはスタッフの優先アドレスですか?
非アクティブ?
 inactive boolean

アドレスは非アクティブですか (つまり、現在の日付は終了日より前です)?
郵送不可?
 do_not_mail boolean

この住所でスタッフに連絡できますか?
日
 seasonal_start.d integer

あいまいな日付で表した日。
月
 seasonal_start.m integer

あいまいな日付で表した月。
年
 seasonal_start.y integer

あいまいな日付で表した年。
日
 seasonal_end.d integer

あいまいな日付で表した日。
月
 seasonal_end.m integer

あいまいな日付で表した月。
年
 seasonal_end.y integer

あいまいな日付で表した年。
追加した日付
 date_added date-time

住所が作成された日付。
変更日
 date_modified date-time

住所が最終変更された日付。

ConstituentApi.AliasRead

エイリアス

名前 パス 型 説明
ID
 id string

エイリアスのシステム レコード ID。
エイリアス
 name string

スタッフのエイリアスとして使用する名前。
タイプ
 type string

エイリアスの種類。

ConstituentApi.ApiCollectionOfAddressRead

住所

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.AddressRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfActionAttachmentRead

Attachments

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.ActionAttachmentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfActionCustomFieldRead

カスタム フィールド

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.ActionCustomFieldRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfActionRead

アクション​​

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.ActionRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfAliasRead

エイリアス

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.AliasRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

Attachments

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.ConstituentAttachmentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfConstituentCodeRead

スタッフ コード

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.ConstituentCodeRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

カスタム フィールド

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.ConstituentCustomFieldRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfConstituentRead

スタッフ

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.ConstituentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfEducationRead

学歴

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.EducationRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfEmailAddressRead

電子メール アドレス

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.EmailAddressRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

基金調達者の割り当て

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.FundraiserAssignmentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfNoteRead

メモ

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.NoteRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfOnlinePresenceRead

オンライン プレゼンス

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.OnlinePresenceRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfPhoneRead

電話

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.PhoneRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfRatingRead

評価

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.RatingRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfRelationshipRead

関係

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.RelationshipRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfSearchResultRead

検索結果

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.SearchResultRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.AppealRead

名前 パス 型 説明
ID
 id string

異議申し立てのシステム レコード ID。
説明
 description string

異議申し立ての説明。

ConstituentApi.CampaignRead

名前 パス 型 説明
ID
 id string

キャンペーンのシステム レコード ID。
説明
 description string

キャンペーンの説明。

ConstituentApi.ConstituentAttachmentRead

添付

名前 パス 型 説明
ID
 id string

添付資料のシステム レコード ID。
スタッフ ID
 parent_id string

添付資料に関連付けられたスタッフのシステム レコード ID。
タイプ
 type string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル URL
 thumbnail_url string

サムネイルの URL。 画像のみの物理的な添付資料の場合。 アクセスを 60 分に制限する、時間期限付きの署名が含まれます。
コンテンツ タイプ
 content_type string

コンテンツの種類。 物理的な添付資料のみ。
ファイル サイズ
 file_size integer

ファイル サイズ (バイト数)。 物理的な添付資料のみ。

ConstituentApi.ConstituentCodeRead

スタッフ コード

名前 パス 型 説明
ID
 id string

スタッフ コードのシステム レコード ID。
スタッフ ID
 constituent_id string

スタッフ コードに関連付けられたスタッフのシステム レコード ID。
スタッフ コード
 description string

スタッフ コード。
日
 start.d integer

あいまいな日付で表した日。
月
 start.m integer

あいまいな日付で表した月。
年
 start.y integer

あいまいな日付で表した年。
日
 end.d integer

あいまいな日付で表した日。
月
 end.m integer

あいまいな日付で表した月。
年
 end.y integer

あいまいな日付で表した年。
非アクティブ?
 inactive boolean

スタッフ コードは非アクティブですか?
シーケンス
 sequence integer

スタッフ コードに関連付けられた数列。
追加した日付
 date_added date-time

スタッフ コードが作成された日付。
変更日
 date_modified date-time

スタッフ コードが最終変更された日付。

ConstituentApi.ConstituentCustomFieldRead

カスタム フィールド

名前 パス 型 説明
ID
 id string

カスタム フィールドのシステム レコード ID。
スタッフ ID
 parent_id string

カスタム フィールドに関連付けられたスタッフのシステム レコード ID。
カテゴリ
 category string

カスタム フィールド カテゴリ。
タイプ
 type string

カスタム フィールドが表すデータの種類。
値
 value

カスタム フィールドの値。
日
 date date

カスタム フィールドの日付。
コメント
 comment string

カスタム フィールドのコメント。 文字数制限: 50。
追加した日付
 date_added date-time

カスタム フィールドが作成された日付。
変更日
 date_modified date-time

カスタム フィールドが最終変更された日付。

ConstituentApi.ConstituentRead

スタッフ

名前 パス 型 説明
ID
 id string

スタッフのシステム レコード ID。 これは、lookup_id に格納されているユーザー定義可能なスタッフ識別子と同じではありません。
タイプ
 type string

スタッフの種類。
敬称
 title string

スタッフの主な役職 (個人のみ)。
名
 first string

スタッフの名 (個人のみ)。
姓
 last string

スタッフの姓 (個人のみ)。
件名
 name string

個人の場合、このフィールドは、対象組織の表示名設定に基づくスタッフの氏名です。 組織の場合、これは組織の名前です。
希望する名前
 preferred_name string

スタッフの希望する名前 (個人のみ)。
敬称
 suffix string

スタッフの主な敬称 (個人のみ)。
検索 ID
 lookup_id string

スタッフのユーザー定義した識別子。
ID
 email.id string

電子メール アドレスのシステム レコード ID。
種類
 email.type string

電子メール アドレスの種類。
アドレス
 email.address string

電子メール アドレス。
電子メール不可?
 email.do_not_email boolean

この電子メール アドレスでスタッフに連絡できますか?
非アクティブ?
 email.inactive boolean

この電子メール アドレスは非アクティブですか?
追加した日付
 email.date_added date-time

電子メール アドレスが作成された日付。
変更日
 email.date_modified date-time

電子メール アドレスが最終変更された日付。
ID
 phone.id string

電話番号のシステム レコード ID。
種類
 phone.type string

電話番号の種類。
数値
 phone.number string

電話番号。
電話不可?
 phone.do_not_call boolean

この電話番号でスタッフに連絡できますか?
非アクティブ?
 phone.inactive boolean

この電話番号は非アクティブですか?
追加した日付
 phone.date_added date-time

電話番号が作成された日付。
変更日
 phone.date_modified date-time

電話番号が最終変更された日付。
ID
 online_presence.id string

オンライン プレゼンスのシステム レコード ID。
種類
 online_presence.type string

オンライン プレゼンスの種類。
リンク
 online_presence.address string

オンライン プレゼンスの Web アドレス。
非アクティブ?
 online_presence.inactive boolean

このオンライン プレゼンスは非アクティブですか?
追加した日付
 online_presence.date_added date-time

オンライン プレゼンスが作成された日付。
変更日
 online_presence.date_modified date-time

オンライン プレゼンスが最終変更された日付。
ID
 address.id string

住所のシステム レコード ID。
種類
 address.type string

住所の種類。
country
 address.country string

住所の国 (ID、名前、または略語形の場合があります)。
行数
 address.address_lines string

住所行。
city
 address.city string

住所の市 (区町村フィールドと組み合わせて使用しないでください)。
状態
 address.state string

住所の状態。
郵便番号
 address.postal_code string

住所の郵便番号。
区町村
 address.suburb string

住所の区町村 (市フィールドと組み合わせて使用しないでください)。
county
 address.county string

住所の郡。
書式設定済
 address.formatted_address string

国の構成済み形式で書式設定された住所。
有効開始日
 address.start date-time

スタッフがこの住所に居住し始めた日付。
有効最終日
 address.end date-time

スタッフがこの住所に居住しなくなった日付。
非アクティブ?
 address.inactive boolean

アドレスは非アクティブですか (つまり、現在の日付は終了日より前です)?
郵送不可?
 address.do_not_mail boolean

この住所でスタッフに連絡できますか?
日
 address.seasonal_start.d integer

あいまいな日付で表した日。
月
 address.seasonal_start.m integer

あいまいな日付で表した月。
年
 address.seasonal_start.y integer

あいまいな日付で表した年。
日
 address.seasonal_end.d integer

あいまいな日付で表した日。
月
 address.seasonal_end.m integer

あいまいな日付で表した月。
年
 address.seasonal_end.y integer

あいまいな日付で表した年。
追加した日付
 address.date_added date-time

住所が作成された日付。
変更日
 address.date_modified date-time

住所が最終変更された日付。
性別
 gender string

スタッフの性別 (個人のみ)。
ミドルネーム
 middle string

スタッフのミドル ネーム (個人のみ)。
旧名
 former_name string

スタッフの旧名 (個人のみ)。
役職 2
 title_2 string

スタッフのセカンダリ役職 (個人のみ)。
敬称 2
 suffix_2 string

スタッフのセカンダリ敬称 (個人のみ)。
婚姻区分
 marital_status string

スタッフの婚姻区分 (個人のみ)。
匿名?
 gives_anonymously boolean

スタッフは匿名ですか?
非アクティブ?
 inactive boolean

スタッフは非アクティブですか?
日
 birthdate.d integer

あいまいな日付で表した日。
月
 birthdate.m integer

あいまいな日付で表した月。
年
 birthdate.y integer

あいまいな日付で表した年。
出生地
 birthplace string

スタッフの出生地 (個人のみ)。
民族
 ethnicity string

スタッフの民族 (個人のみ)。
収益
 income string

スタッフの収入 (個人のみ)。
宗教
 religion string

スタッフの宗教 (個人のみ)。
業種
 industry string

スタッフの業種 (組織のみ)。
従業員数
 num_employees integer

組織の従業員数。
ギフトと一致?
 matches_gifts boolean

組織はギフトと一致していますか?
一致するギフト要素
 matching_gift_factor double

一致するギフト要素 (組織のみ)。
ギフトあたりの最小一致
 matching_gift_per_gift_min.value double

スタッフのギフトあたりの最小一致額 (組織のみ)。
ギフトあたりの最大一致
 matching_gift_per_gift_max.value double

スタッフのギフトあたりの最大一致額 (組織のみ)。
スタッフあたりの最小一致
 matching_gift_total_min.value double

スタッフの最小一致合計 (組織のみ)。
スタッフあたりの最大一致
 matching_gift_total_max.value double

スタッフの最大一致合計 (組織のみ)。
一致するギフト メモ
 matching_gift_notes string

スタッフの一致するギフト メモ (組織のみ)。
年齢
 age integer

生年月日プロパティに基づいて計算された、スタッフの年齢 (個人のみ)。
故人?
 deceased boolean

故人であるスタッフですか (個人のみ)?
日
 deceased_date.d integer

あいまいな日付で表した日。
月
 deceased_date.m integer

あいまいな日付で表した月。
年
 deceased_date.y integer

あいまいな日付で表した年。
基金調達者ステータス
 fundraiser_status string

スタッフが基金調達者であるかどうかを示します (個人のみ)。
ID
 spouse.id string

配偶者のシステム レコード ID。
名
 spouse.first string

配偶者の名。
姓
 spouse.last string

配偶者の姓。
世帯主?
 spouse.is_head_of_household boolean

配偶者は世帯主ですか?
追加した日付
 date_added date-time

スタッフが作成された日付。
変更日
 date_modified date-time

スタッフが最終変更された日付。

ConstituentApi.CreatedAction

作成済みアクション

名前 パス 型 説明
ID
 id string

新しく作成されたアクションの ID。

ConstituentApi.CreatedActionAttachment

作成済みアクション添付資料

名前 パス 型 説明
ID
 id string

新しく作成されたアクション添付資料の ID。

ConstituentApi.CreatedActionCustomField

作成済みアクション カスタム フィールド

名前 パス 型 説明
ID
 id string

新しく作成されたアクション カスタム フィールドの ID。

ConstituentApi.CreatedConstituentAddress

作成済みスタッフ住所

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ住所の ID。

ConstituentApi.CreatedConstituentAlias

作成済みスタッフ エイリアス

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ エイリアスの ID。

ConstituentApi.CreatedConstituentAttachment

作成済みスタッフ添付資料

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ添付資料の ID。

ConstituentApi.CreatedConstituentCode

作成済みスタッフ コード

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ コードの ID。

ConstituentApi.CreatedConstituentCustomField

作成済みスタッフのカスタム フィールド

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ カスタム フィールドの ID。

ConstituentApi.CreatedConstituentEducation

作成済みスタッフ教育

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ学歴の ID。

ConstituentApi.CreatedConstituentEmailAddress

作成済みスタッフの電子メール アドレス

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ電子メール アドレスの ID。

ConstituentApi.CreatedConstituentNote

作成済みスタッフ メモ

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ メモの ID。

ConstituentApi.CreatedConstituentOnlinePresence

作成済みスタッフのオンライン プレゼンス

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフオンライン プレゼンスの ID。

ConstituentApi.CreatedConstituentPhone

作成済みスタッフの電話番号

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ電話番号の ID。

ConstituentApi.CreatedConstituentRating

作成済みスタッフの評価

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ評価の ID。

ConstituentApi.CreatedIndividualConstituent

作成済み個々のスタッフ

名前 パス 型 説明
ID
 id string

新しく作成された個々のスタッフの ID。

ConstituentApi.CreatedIndividualRelationship

作成済み個々の関係

名前 パス 型 説明
ID
 id string

新しく作成された個々の関連付けの ID。

ConstituentApi.CreatedOrganizationConstituent

作成済み組織スタッフ

名前 パス 型 説明
ID
 id string

新しく作成された組織スタッフの ID。

ConstituentApi.CreatedOrganizationRelationship

作成済み組織の関連付け

名前 パス 型 説明
ID
 id string

新しく作成された組織の関連付けの ID。

ConstituentApi.EducationRead

教育です

名前 パス 型 説明
ID
 id string

学歴のシステム レコード ID。
スタッフ ID
 constituent_id string

教育に関連付けられたスタッフのシステム レコード ID。
学校
 school string

学校/施設名。
タイプ
 type string

学歴の種類。
同期生
 class_of string

スタッフが卒業した年。
ステータス
 status string

学歴のステータス。
日
 date_entered.d integer

あいまいな日付で表した日。
月
 date_entered.m integer

あいまいな日付で表した月。
年
 date_entered.y integer

あいまいな日付で表した年。
日
 date_left.d integer

あいまいな日付で表した日。
月
 date_left.m integer

あいまいな日付で表した月。
年
 date_left.y integer

あいまいな日付で表した年。
日
 date_graduated.d integer

あいまいな日付で表した日。
月
 date_graduated.m integer

あいまいな日付で表した月。
年
 date_graduated.y integer

あいまいな日付で表した年。
学位
 degree string

終了した学位。
GPA
 gpa double

成績平均点。
主専攻
 majors array of string

研究の専攻コース。
副専攻
 minors array of string

研究の副専攻コース。
プライマリ学歴?
 primary boolean

これはスタッフのプライマリ学校協会ですか?
キャンパス
 campus string

キャンパス。
社会組織
 social_organization string

社会組織。
既知の名前
 known_name string

既知の名前。
学位の種類
 class_of_degree string

学位の種類。
部署
 department string

学科の名前。
学部
 faculty string

学部の名前。
登録番号
 registration_number string

登録番号。
研究のテーマ
 subject_of_study string

研究のテーマ。
追加した日付
 date_added date-time

学歴が作成された日付。
変更日
 date_modified date-time

学歴が最終変更された日付。

ConstituentApi.EmailAddressRead

メール アドレス

名前 パス 型 説明
ID
 id string

電子メール アドレスのシステム レコード ID。
スタッフ ID
 constituent_id string

電子メール アドレスに関連付けられたスタッフのシステム レコード ID。
電子メールの種類
 type string

電子メール アドレスの種類。
メール アドレス
 address string

電子メール アドレス。
プライマリ?
 primary boolean

これはスタッフの優先電子メール アドレスですか?
電子メール不可?
 do_not_email boolean

この電子メール アドレスでスタッフに連絡できますか?
非アクティブ?
 inactive boolean

この電子メール アドレスは非アクティブですか?
追加した日付
 date_added date-time

電子メール アドレスが作成された日付。
変更日
 date_modified date-time

電子メール アドレスが最終変更された日付。

ConstituentApi.FileDefinition

ファイル定義

名前 パス 型 説明
ファイル ID
 file_id string

ファイルの識別子。
URL
 file_upload_request.url string

要求のアップロードに使用する URL。
メソッド
 file_upload_request.method string

要求のアップロードに使用する HTTP メソッド。
ヘッダー
 file_upload_request.headers array of ConstituentApi.Header

要求の実行時に提供するヘッダー。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。
URL
 thumbnail_upload_request.url string

要求のアップロードに使用する URL。
メソッド
 thumbnail_upload_request.method string

要求のアップロードに使用する HTTP メソッド。
ヘッダー
 thumbnail_upload_request.headers array of ConstituentApi.Header

要求の実行時に提供するヘッダー。

ConstituentApi.FundraiserAssignmentRead

基金調達者の割り当て

名前 パス 型 説明
ID
 id string

基金調達者割り当てのシステム レコード ID。
スタッフ ID
 constituent_id string

基金調達者に割り当てられたスタッフのシステム レコード ID。
基金調達者 ID
 fundraiser_id string

基金調達者のシステム レコード ID。
タイプ
 type string

基金調達者の種類。
値
 amount.value double

金額。
キャンペーン ID
 campaign_id string

ギフトを適用することになる、キャンペーン対象のシステム レコード ID。
資金 ID
 fund_id string

任意のギフトを適用する必要がある、資金対象のシステム レコード ID。 制限付き資金が選択された場合、その資金に関連付けられたキャンペーンと異議申し立てのみを選択できます。
訴求力 ID
 appeal_id string

ギフトを要求するために資金調達者が使用すべきアピールのシステム レコード ID。
開始日
 start date-time

資金調達者の割り当て開始日。
終了日
 end date-time

資金調達者の割り当て終了日。

ConstituentApi.FundRead

名前 パス 型 説明
ID
 id string

資金のシステム レコード ID。
説明
 description string

資金の説明。

ConstituentApi.GivingSummaryRead

寄付の概要

名前 パス 型 説明
ID
 id string

贈与のシステム レコード ID。
タイプ
 type string

ギフトの種類。
日
 date date-time

ギフトの日付。
値
 amount.value double

金額。
異議申し立て
 appeals array of ConstituentApi.AppealRead

贈与に関連付けられた異議申し立てセット。
キャンペーン
campaigns array of ConstituentApi.CampaignRead

贈与に関連付けられたキャンペーン セット。
資金
 funds array of ConstituentApi.FundRead

ギフトに関連付けられた資金セット。

ConstituentApi.Header

物理的な添付資料のアップロードに使用する要求ヘッダー。

名前 パス 型 説明
名前
 name string

ヘッダーの名前。
値
 value string

ヘッダーの値。

ConstituentApi.LifetimeGivingRead

生涯寄付

名前 パス 型 説明
寄付を受けた連続する年数
 consecutive_years_given integer

スタッフが勤務した連続した年数。
寄付を受けた合計年数
 total_years_given integer

スタッフが寄付を受けた合計年数。
値
 total_giving.value double

金額。
値
 total_pledge_balance.value double

金額。
値
 total_received_giving.value double

金額。
値
 total_committed_matching_gifts.value double

金額。
値
 total_received_matching_gifts.value double

金額。
値
 total_soft_credits.value double

金額。

ConstituentApi.NoteRead

メモ

名前 パス 型 説明
ID
 id string

メモのシステム レコード ID。
スタッフ ID
 constituent_id string

メモに関連付けられたスタッフのシステム レコード ID。
タイプ
 type string

メモの種類。
日
 date.d integer

あいまいな日付で表した日。
月
 date.m integer

あいまいな日付で表した月。
年
 date.y integer

あいまいな日付で表した年。
サマリー
 summary string

メモの概要。
メモ
text string

メモのテキスト。
追加した日付
 date_added date-time

メモが作成された日付。
変更日
 date_modified date-time

メモが最終変更された日付。

ConstituentApi.OnlinePresenceRead

オンライン プレゼンス

名前 パス 型 説明
ID
 id string

オンライン プレゼンスのシステム レコード ID。
スタッフ ID
 constituent_id string

オンライン プレゼンスに関連付けられたスタッフのシステム レコード ID。
タイプ
 type string

オンライン プレゼンスの種類。
リンク
 address string

オンライン プレゼンスの Web アドレス。
プライマリ?
 primary boolean

これはスタッフの優先オンライン プレゼンスですか?
非アクティブ?
 inactive boolean

このオンライン プレゼンスは非アクティブですか?
追加した日付
 date_added date-time

オンライン プレゼンスが作成された日付。
変更日
 date_modified date-time

オンライン プレゼンスが最終変更された日付。

ConstituentApi.PhoneRead

電話

名前 パス 型 説明
ID
 id string

電話番号のシステム レコード ID。
スタッフ ID
 constituent_id string

電話番号に関連付けられたスタッフのシステム レコード ID。
タイプ
 type string

電話番号の種類。
数
 number string

電話番号。
プライマリ?
 primary boolean

これはスタッフの優先電話番号ですか?
電話不可?
 do_not_call boolean

この電話番号でスタッフに連絡できますか?
非アクティブ?
 inactive boolean

この電話番号は非アクティブですか?
追加した日付
 date_added date-time

電話番号が作成された日付。
変更日
 date_modified date-time

電話番号が最終変更された日付。

ConstituentApi.ProfilePictureRead

プロファイル画像

名前 パス 型 説明
スタッフ ID
 constituent_id string

プロフィール画像に関連付けられたスタッフのシステム レコード ID。
URL
 url string

プロファイル画像の URL。 URL にはアクセスを 60 分に制限する、時間期限付きの署名が含まれます。
サムネイル URL
 thumbnail_url string

プロフィール画像のサムネイルの URL。 アクセスを 60 分に制限する、時間期限付きの署名が含まれます。

ConstituentApi.ProspectStatusRead

見込顧客の状態

名前 パス 型 説明
ステータス
 status string

スタッフが担当する現在の見込顧客の状態。
経過した日数
 days_elapsed integer

現在の見込顧客の状態の、開始日に基づく合計日数。
開始日
 start date-time

見込顧客の状態の開始日。
コメント
 comments string

見込顧客の状態に関するコメント。

ConstituentApi.RatingRead

Rating

名前 パス 型 説明
ID
 id string

評価のシステム レコード ID。
スタッフ ID
 constituent_id string

評価に関連付けられたスタッフのシステム レコード ID。
ソース
 source string

新しい評価のソース。
カテゴリ
 category string

評価のカテゴリ。
日
 date date-time

評価の日付。
内容
 value

評価の値。
コメント
 comment string

評価に関するコメント。
非アクティブ?
 inactive boolean

評価は非アクティブですか?
タイプ
 type string

この計算フィールドは、カテゴリ プロパティに基づいて評価で示されるデータの種類を表します。

ConstituentApi.RelationshipRead

関係

名前 パス 型 説明
ID
 id string

関係のシステム レコード ID。
スタッフ ID
 constituent_id string

関連付けに関連付けられたスタッフのシステム レコード ID。
関連 ID
 relation_id string

関連する個人や組織のシステム レコード ID。
相互関係 ID
 reciprocal_relationship_id string

相互の関係レコードの識別子。 この値は読み取り専用であり、関係の作成時に自動的に生成されます。 このレコードを変更すると、コメント プロパティ以外の相互関係に反映されます。
件名
 name string

関連するスタッフの名前。 関連スタッフが個人の場合、対象組織の表示名の設定に基づいてこのスタッフの氏名が表示されます。
タイプ
 type string

関連付けが表す関係の種類。
相互の種類
 reciprocal_type string

関連するスタッフとのスタッフ関連付けを説明します。 たとえば、男性スタッフと女性兄弟の関係では、相互関係の種類は兄弟になります。
日
 start.d integer

あいまいな日付で表した日。
月
 start.m integer

あいまいな日付で表した月。
年
 start.y integer

あいまいな日付で表した年。
日
 end.d integer

あいまいな日付で表した日。
月
 end.m integer

あいまいな日付で表した月。
年
 end.y integer

あいまいな日付で表した年。
配偶者?
 is_spouse boolean

関連個人はスタッフの配偶者ですか (個人間のリレーションシップにのみ適用されます)?
スタッフは世帯主?
 is_constituent_head_of_household boolean

スタッフは世帯主ですか?
配偶者は世帯主?
 is_spouse_head_of_household boolean

配偶者は世帯主ですか?
メモ
comment string

リレーションシップに関するコメント。
取引先担当者?
 is_organization_contact boolean

スタッフは取引先担当者としてこの組織を代表しますか (組織と個人間のリレーションシップにのみ適用されます)?
プライマリ事業?
 is_primary_business boolean

これはスタッフの主事業ですか (組織と個人間のリレーションシップにのみ適用されます)?
取引先担当者の種類
 organization_contact_type string

取引先担当者として組織を代表する関連個人との対話のコンテキストを提供します。 組織と個人間のリレーションシップにのみ適用されます。
位置
 position string

組織内での個人のポジション。 組織と個人間のリレーションシップにのみ適用されます。
追加した日付
 date_added date-time

関係の作成日。
変更日
 date_modified date-time

関係を最終変更した日付。

ConstituentApi.SearchResultRead

検索結果

名前 パス 型 説明
ID
 id string

スタッフのシステム レコード ID。
件名
 name string

スタッフ名。 個人の場合、この計算フィールドには、スタッフの対象組織の表示名の設定に基づいて氏名が表示されます。
住所
address string

スタッフの優先住所。
故人?
 deceased boolean

このスタッフは故人ですか?
電子メール
 email string

スタッフの電子メール アドレス。
資金調達者の状態
 fundraiser_status string

スタッフの資金調達者の状態。 個人の場合、この計算フィールドは、スタッフが「アクティブ」、「非アクティブ」、または「なし」のいずれであるかを示します。 組織の場合、この値は常に「なし」になります。
非アクティブ?
 inactive boolean

スタッフは非アクティブですか?
検索 ID
 lookup_id string

スタッフのユーザー定義した識別子。

EventApi.AdministrativeArea

住所の行政区画で使用されるデータ モデルを定義します (例: 米国における州)。

名前 パス 型 説明
ID
 id string

行政区画のレコード ID。
名前
 name string

行政区画の名前。
簡単な説明
 short_description string

行政区画の簡単な説明。

EventApi.ApiCollectionOfEventFee

手数料

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of EventApi.EventFee

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

EventApi.ApiCollectionOfEventListEntry

イベント

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of EventApi.EventListEntry

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

EventApi.ApiCollectionOfEventParticipantOption

イベントの参加者オプション

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of EventApi.EventParticipantOption

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

EventApi.ApiCollectionOfParticipantDonation

寄付

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of EventApi.ParticipantDonation

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

EventApi.ApiCollectionOfParticipantFee

手数料

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of EventApi.ParticipantFee

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

EventApi.ApiCollectionOfParticipantFeePayment

手数料支払

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of EventApi.ParticipantFeePayment

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

EventApi.ApiCollectionOfParticipantListEntry

参加者

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of EventApi.ParticipantListEntry

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

EventApi.ApiCollectionOfParticipantOption

参加者オプション

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of EventApi.ParticipantOption

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

EventApi.Country

住所の国に使用するデータ モデルを定義します。

名前 パス 型 説明
ID
 id string

国レコードの ID。
表示名
 display_name string

国の表示名。
ISO コード
 iso_alpha2_code string

国を表す ISO 3166-1 alpha-2 コード。

EventApi.CreatedEvent

作成したイベント

名前 パス 型 説明
ID
 id string

新しく作成したイベントの ID。

EventApi.CreatedEventFee

作成済みイベント料金

名前 パス 型 説明
ID
 id string

新しく作成したイベント料金の ID。

EventApi.CreatedEventParticipantOption

作成済みイベントの参加者オプション

名前 パス 型 説明
ID
 id string

新しく作成したイベント参加者オプションの ID。

EventApi.CreatedParticipant

作成した参加者

名前 パス 型 説明
ID
 id string

新しく作成した参加者の ID。

EventApi.CreatedParticipantDonation

参加者の寄付を作成する

名前 パス 型 説明
ID
 id string

新しく作成した参加者の寄付に対する ID。

EventApi.CreatedParticipantFee

作成済み参加者費用

名前 パス 型 説明
ID
 id string

新しく作成した参加者料金の ID。

EventApi.CreatedParticipantFeePayment

作成済み参加者の手数料支払

名前 パス 型 説明
ID
 id string

新しく作成した参加者の料金支払いの ID。

EventApi.CreatedParticipantOption

作成済み参加者オプション

名前 パス 型 説明
ID
 id string

新しく作成した参加者オプションの ID。

EventApi.Event

イベント

名前 パス 型 説明
ID
 id string

イベントのシステム レコード ID。 これは、lookup_id に格納されているユーザー定義可能なイベント識別子と同じではありません。
件名
 name string

イベントの名前です。
内容
 description string

イベントの説明。
開始日
 start_date date

イベントの開始日。
開始時刻
 start_time string

イベントの開始時刻。
終了日
 end_date date

イベントの終了日。
終了時刻
 end_time string

イベントの終了時刻。
カテゴリ
 category EventApi.EventCategory

イベント カテゴリは、イベントのカスタム分類です。
検索 ID
 lookup_id string

イベントの検索 ID。
場所
 location EventApi.Location

場所に使用するデータ モデルを定義します。
容量
 capacity integer

イベントに参加できる人数。
目標
goal double

イベントの目標金額。
キャンペーン ID
 campaign_id string

イベントに関連付けられたキャンペーンのシステム レコード ID。
資金 ID
 fund_id string

イベントに関連付けられた資金のシステム レコード ID。
非アクティブ?
 inactive boolean

イベントは非アクティブですか?
追加した日付
 date_added date-time

イベントの作成日。
変更日
 date_modified date-time

イベントの最終変更日。

EventApi.EventCategory

イベント カテゴリは、イベントのカスタム分類です。

名前 パス 型 説明
ID
 id string

イベント カテゴリのシステム レコード ID。
名前
 name string

イベント カテゴリの名前。
非アクティブ?
 inactive boolean

このカテゴリは非アクティブですか?

EventApi.EventFee

イベント料金は、個人や組織がイベントに参加または出席する際に組織が請求する金額です。

名前 パス 型 説明
ID
 id string

イベント料金のシステム レコード ID。
名前
 name string

イベント料金の名前。
金額
 cost double

料金のコスト。
寄付額
 contribution_amount double

この料金の税金控除額。
売上数
 number_sold integer

販売された料金の数。

EventApi.EventListEntry

イベント

名前 パス 型 説明
ID
 id string

イベントのシステム レコード ID。
件名
 name string

イベントの名前です。
開始日
 start_date date

イベントの開始日。
開始時刻
 start_time string

イベントの開始時刻。
終了日
 end_date date

イベントの終了日。
終了時刻
 end_time string

イベントの終了時刻。
カテゴリ
 category EventApi.EventCategory

イベント カテゴリは、イベントのカスタム分類です。
検索 ID
 lookup_id string

イベントの検索 ID。
容量
 capacity integer

イベントに参加できる人数。
出席
 attending_count integer

出席を予定しているイベント参加者の数。
有人
 attended_count integer

イベント出席者の数。
招待済み
 invited_count integer

イベントに招待された人の数。
売上
 revenue double

イベントの売上高。
目標
goal double

イベントの目標金額。
目標に対する割合
 percent_of_goal integer

目標売上に対する割合としての売上高。
非アクティブ?
 inactive boolean

イベントは非アクティブですか?
追加した日付
 date_added date-time

イベントの作成日。
変更日
 date_modified date-time

イベントの最終変更日。

EventApi.EventParticipantOption

イベント参加者のオプションは、T シャツのサイズ、食事の好み、座席の希望など、参加者に関する詳細情報を収集するフィールドです。 イベントのオプションとその値を設定してから、各参加者の応答を追加します。

名前 パス 型 説明
ID
 id string

イベント参加者オプションのシステム レコード ID。
名前
 name string

イベント参加者オプションの名前。
入力の種類
 input_type string

イベント参加者オプションの種類。
マルチ選択を許可?
 multi_select boolean

一覧に対して複数の値を許可しますか?
list_options
 list_options array of EventApi.EventParticipantOptionListOption

使用可能な一覧のオプション。
ユーザーにより追加済
 added_by_user string

オプションを追加したユーザーの ID。
ユーザーにより変更済
 updated_by_user string

オプションを変更したユーザーの ID。
サービスにより追加済
 added_by_service string

このオプションを追加したサービスの名前。
サービスにより変更済
 updated_by_service string

このオプションを変更したサービスの名前。
追加日
 date_added date-time

オプションが作成された日付。
変更日
 date_updated date-time

オプションが最終変更された日付。
バージョン
 version integer

オプションのバージョン番号。

EventApi.EventParticipantOptionListOption

イベント参加者オプションの一覧オプション

名前 パス 型 説明
ID
 id string

一覧オプションの ID
名前
 name string

一覧オプションの名前
sequence
 sequence integer

一覧オプションの順序付けに使用するシーケンス

EventApi.Locality

住所の地域に使用するデータ モデルを定義します。

名前 パス 型 説明
ID
 id string

地域レコードのレコード ID。
名前
 name string

地域の名前。

EventApi.Location

場所に使用するデータ モデルを定義します。

名前 パス 型 説明
名前
 name string

場所の名前。
住所行
 address_lines string

場所の住所行。
郵便番号
 postal_code string

場所の郵便番号。
地域
 locality EventApi.Locality

住所の地域に使用するデータ モデルを定義します。
行政区画
 administrative_area EventApi.AdministrativeArea

住所の行政区画で使用されるデータ モデルを定義します (例: 米国における州)。
副行政区画
 sub_administrative_area EventApi.SubAdministrativeArea

住所の副行政区画で使用するデータ モデルを定義します (例: 米国における市)。
country
 country EventApi.Country

住所の国に使用するデータ モデルを定義します。
書式設定された住所
 formatted_address string

場所の書式設定された住所

EventApi.Membership

参加者のメンバーシップ情報。

名前 パス 型 説明
メンバーシップ カテゴリ
 category EventApi.MembershipCategory

個人のメンバーシップ カテゴリ。

EventApi.MembershipCategory

個人のメンバーシップ カテゴリ。

名前 パス 型 説明
ID
 id string

メンバーシップ カテゴリのシステム レコード ID。
名前
 name string

メンバーシップ カテゴリの名前。

EventApi.Participant

関係者

名前 パス 型 説明
ID
 id string

参加者のシステム レコード ID。
スタッフ ID
 constituent_id string

参加者のスタッフ ID。
イベント ID
 event_id string

参加しているイベントのシステム レコード ID。
ホスト ID
 host_id string

ホストの参加者レコードの ID。
RSVP の状態
 rsvp_status string

参加者のイベントへのエンゲージメントのステータス。
参加済?
 attended boolean

参加者はイベントに参加しましたか?
招待の状態
 invitation_status string

参加者への招待のステータス。
日
 rsvp_date.d integer

あいまいな日付で表した日。
月
 rsvp_date.m integer

あいまいな日付で表した月。
年
 rsvp_date.y integer

あいまいな日付で表した年。
日
 invitation_date.d integer

あいまいな日付で表した日。
月
 invitation_date.m integer

あいまいな日付で表した月。
年
 invitation_date.y integer

あいまいな日付で表した年。
参加レベル
 participation_level EventApi.ParticipationLevel

参加レベルは、イベントに対する参加者の関わり合いのレベルです。
追加した日付
 date_added date-time

参加者が作成された日付。
変更日
 date_modified date-time

参加者が最終変更された日付。

EventApi.ParticipantDonation

参加者の寄付に使用するデータ モデルを定義する

名前 パス 型 説明
ID
 id string

参加者の寄付に対するシステム レコード ID。
ギフト ID
 gift_id string

参加者の寄付をリンクしたギフトに対するシステム レコード ID。

EventApi.ParticipantFee

参加者料金のデータ モデルを定義します

名前 パス 型 説明
ID
 id string

参加者料金の ID。
参加者 ID
 participant_id string

参加者料金がリンクされるレコードの ID。
数量
 quantity integer

購入済みの数量。
手数料の金額
 fee_amount double

参加者料金の額。
寄付額
 tax_receiptable_amount double

この料金の税金控除額。
日
 date.d integer

あいまいな日付で表した日。
月
 date.m integer

あいまいな日付で表した月。
年
 date.y integer

あいまいな日付で表した年。
イベント料金
 event_fee EventApi.EventFee

イベント料金は、個人や組織がイベントに参加または出席する際に組織が請求する金額です。

EventApi.ParticipantFeePayment

参加者料金の支払いのデータ モデルを定義します

名前 パス 型 説明
ID
 id string

参加者料金の支払いのシステム レコード ID。
参加者 ID
 participant_id string

参加者料金の支払いをリンクする参加者のシステム レコード ID。
ギフト ID
 gift_id string

参加者料金の支払いをリンクするギフトのシステム レコード ID。
適用額
 applied_amount double

参加者料金の支払いに適用される金額。

EventApi.ParticipantListEntry

関係者

名前 パス 型 説明
ID
 id string

参加者のシステム レコード ID。
取引先担当者 ID
 contact_id string

イベントに参加中の取引先担当者の ID。
RSVP の状態
 rsvp_status string

参加者のイベントへのエンゲージメントのステータス。
参加済?
 attended boolean

参加者はイベントに参加しましたか?
招待の状態
 invitation_status string

参加者への招待のステータス。
日
 rsvp_date.d integer

あいまいな日付で表した日。
月
 rsvp_date.m integer

あいまいな日付で表した月。
年
 rsvp_date.y integer

あいまいな日付で表した年。
参加レベル
 participation_level EventApi.ParticipationLevel

参加レベルは、イベントに対する参加者の関わり合いのレベルです。
敬称
 title string

参加者の役職。
名
 first_name string

参加者の名。
姓
 last_name string

参加者の姓。
件名
 name string

参加者の氏名。
希望する名前
 preferred_name string

参加者の希望する名前。
敬称
 suffix string

参加者の敬称。
検索 ID
 lookup_id string

参加者の LookupId。
電子メール
 email string

参加者の電子メール アドレス。
電子メール不可?
 do_not_email boolean

この電子メール アドレスで参加者に連絡を取ることができますか?
電話
 phone string

参加者の電話番号。
電話不可?
 do_not_call boolean

この電話番号で参加者に連絡を取ることができますか?
ミドルネーム
 middle_name string

参加者のミドル ネーム。
旧名
 former_name string

参加者の旧名。
スタッフ?
 is_constituent boolean

参加者はスタッフですか?
学位
 class_of string

参加者の卒業時学位。
合計登録料
 total_registration_fees double

参加者の手数料の合計。
合計支払い金額
 total_paid double

参加者の支払い済みギフトと登録料の種類の合計。
シート
 seat string

参加者の座席割り当て。
名前タグ
 name_tag string

参加者の名前タグ
追加した日付
 date_added date-time

参加者が作成された日付。
変更日
 date_modified date-time

参加者が最終変更された日付。
取引先担当者 ID
 host.contact_id string

イベントに参加中の取引先担当者の ID。
参加者 ID
 host.participant_id string

参加者の ID。
名前
 host.name string

参加者の氏名。
ゲスト
 guests array of EventApi.ParticipantListParticipantSummary

参加者のゲスト。
メンバーシップ
 memberships array of EventApi.Membership

参加者のメンバーシップ情報。

EventApi.ParticipantListParticipantSummary

参加者の基本概要情報。

名前 パス 型 説明
取引先担当者 ID
 contact_id string

イベントに参加中の取引先担当者の ID。
参加者 ID
 participant_id string

参加者の ID。
名前
 name string

参加者の氏名。

EventApi.ParticipantOption

特定の参加者に関連付けられた参加者オプション

名前 パス 型 説明
ID
 id string

参加者オプションのシステム レコード ID。
参加者 ID
 participant_id string

参加者のシステム レコード ID。
イベント ID
 event_id string

イベントのシステム レコード ID。
イベント参加者オプション ID
 event_participant_option_id string

イベント参加者オプションのシステム レコード ID。
値
 option_value string

オプションに対する参加者の応答。
ユーザーにより追加済
 added_by_user string

参加者オプションを追加したユーザーの ID。
ユーザーにより変更済
 updated_by_user string

参加者オプションを変更したユーザーの ID。
サービスにより追加済
 added_by_service string

この参加者オプションを追加したサービスの名前。
サービスにより変更済
 updated_by_service string

この参加者オプションを変更したサービスの名前。
追加日
 date_added date-time

参加者オプションが作成された日付。
変更日
 date_updated date-time

参加者オプションが最終変更された日付。

EventApi.ParticipationLevel

参加レベルは、イベントに対する参加者の関わり合いのレベルです。

名前 パス 型 説明
ID
 id string

参加レベルのシステム レコード ID。
名前
 name string

参加レベルの名前。
非アクティブ?
 is_inactive boolean

参加レベルは非アクティブですか?

EventApi.SubAdministrativeArea

住所の副行政区画で使用するデータ モデルを定義します (例: 米国における市)。

名前 パス 型 説明
ID
 id string

副行政区画の ID。
名前
 name string

副行政区画の名前。

FundraisingApi.ApiCollectionOfAppealAttachmentRead

Attachments

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of FundraisingApi.AppealAttachmentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

FundraisingApi.ApiCollectionOfAppealCustomFieldRead

カスタム フィールド

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of FundraisingApi.AppealCustomFieldRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

FundraisingApi.ApiCollectionOfAppealRead

異議申し立て

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of FundraisingApi.AppealRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

FundraisingApi.ApiCollectionOfCampaignAttachmentRead

Attachments

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of FundraisingApi.CampaignAttachmentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

カスタム フィールド

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of FundraisingApi.CampaignCustomFieldRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

FundraisingApi.ApiCollectionOfCampaignRead

キャンペーン

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of FundraisingApi.CampaignRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

FundraisingApi.ApiCollectionOfFundAttachmentRead

Attachments

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of FundraisingApi.FundAttachmentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

FundraisingApi.ApiCollectionOfFundCustomFieldRead

カスタム フィールド

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of FundraisingApi.FundCustomFieldRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

FundraisingApi.ApiCollectionOfFundRead

資金

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of FundraisingApi.FundRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

割り当て

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of FundraisingApi.FundraiserAssignmentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

FundraisingApi.ApiCollectionOfPackageRead

パッケージ

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of FundraisingApi.PackageRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

FundraisingApi.AppealAttachmentRead

添付

名前 パス 型 説明
ID
 id string

添付資料のシステム レコード ID。
訴求力 ID
 parent_id string

添付資料に関連付けられた異議申し立てのシステム レコード ID。
タイプ
 type string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル URL
 thumbnail_url string

サムネイルの URL。 画像のみの物理的な添付資料の場合。 アクセスを 60 分に制限する、時間期限付きの署名が含まれます。
コンテンツ タイプ
 content_type string

コンテンツの種類。 物理的な添付資料のみ。
ファイル サイズ
 file_size integer

ファイル サイズ (バイト数)。 物理的な添付資料のみ。

FundraisingApi.AppealCustomFieldRead

カスタム フィールド

名前 パス 型 説明
ID
 id string

カスタム フィールドのシステム レコード ID。
訴求力 ID
 parent_id string

カスタム フィールドに関連付けられた異議申し立てのシステム レコード ID。
カテゴリ
 category string

カスタム フィールド カテゴリ。
タイプ
 type string

カスタム フィールドが表すデータの種類。
値
 value

カスタム フィールドの値。
日
 date date

カスタム フィールドの日付。
コメント
 comment string

カスタム フィールドのコメント。 文字数制限: 50。
追加した日付
 date_added date-time

カスタム フィールドが作成された日付。
変更日
 date_modified date-time

カスタム フィールドが最終変更された日付。

FundraisingApi.AppealRead

異議申し立て

名前 パス 型 説明
ID
 id string

異議申し立てのシステム レコード ID。
カテゴリ
 category string

異議申し立てのカテゴリ。
追加した日付
 date_added date-time

異議申し立てが作成された日付。
変更日
 date_modified date-time

異議申し立てが最終変更された日付。
内容
 description string

異議申し立ての表示名。
終了日
 end_date date-time

異議申し立ての終了日。
値
 goal.value double

金額。
非アクティブ?
 inactive boolean

異議申し立ては非アクティブ (現在の日付が任意の開始日より後で、終了日より前) ですか?
検索 ID
 lookup_id string

異議申し立てのユーザー定義の識別子。
開始日
 start_date date-time

異議申し立ての開始日。

FundraisingApi.CampaignAttachmentRead

添付

名前 パス 型 説明
ID
 id string

添付資料のシステム レコード ID。
キャンペーン ID
 parent_id string

添付資料に関連付けられたキャンペーンのシステム レコード ID。
タイプ
 type string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル URL
 thumbnail_url string

サムネイルの URL。 画像のみの物理的な添付資料の場合。 アクセスを 60 分に制限する、時間期限付きの署名が含まれます。
コンテンツ タイプ
 content_type string

コンテンツの種類。 物理的な添付資料のみ。
ファイル サイズ
 file_size integer

ファイル サイズ (バイト数)。 物理的な添付資料のみ。

FundraisingApi.CampaignCustomFieldRead

カスタム フィールド

名前 パス 型 説明
ID
 id string

カスタム フィールドのシステム レコード ID。
キャンペーン ID
 parent_id string

カスタム フィールドに関連付けられたキャンペーンのシステム レコード ID。
カテゴリ
 category string

カスタム フィールド カテゴリ。
タイプ
 type string

カスタム フィールドが表すデータの種類。
値
 value

カスタム フィールドの値。
日
 date date

カスタム フィールドの日付。
コメント
 comment string

カスタム フィールドのコメント。 文字数制限: 50。
追加した日付
 date_added date-time

カスタム フィールドが作成された日付。
変更日
 date_modified date-time

カスタム フィールドが最終変更された日付。

FundraisingApi.CampaignRead

キャンペーン

名前 パス 型 説明
ID
 id string

キャンペーンのシステム レコード ID。
カテゴリ
 category string

キャンペーンのカテゴリ。
追加した日付
 date_added date-time

キャンペーンが作成された日付。
変更日
 date_modified date-time

キャンペーンが最終変更された日付。
内容
 description string

キャンペーンの表示名。
終了日
 end_date date-time

キャンペーンの終了日。
値
 goal.value double

金額。
非アクティブ?
 inactive boolean

キャンペーンは非アクティブ (現在の日付が任意の開始日より後で、終了日より前) ですか?
検索 ID
 lookup_id string

キャンペーンのユーザー定義の識別子。
開始日
 start_date date-time

キャンペーンの開始日。

FundraisingApi.CreatedAppealAttachment

作成済み異議申し立て添付資料

名前 パス 型 説明
ID
 id string

新しく作成された異議申し立ての添付資料の ID。

FundraisingApi.CreatedAppealCustomField

作成済み異議申し立てカスタム フィールド

名前 パス 型 説明
ID
 id string

新しく作成された異議申し立てのカスタム フィールドの ID。

FundraisingApi.CreatedCampaignAttachment

作成済みキャンペーン添付資料

名前 パス 型 説明
ID
 id string

新しく作成されたキャンペーンの添付資料の ID。

FundraisingApi.CreatedCampaignCustomField

作成済みキャンペーンのカスタム フィールド

名前 パス 型 説明
ID
 id string

新しく作成されたキャンペーンのカスタム フィールドの ID。

FundraisingApi.CreatedFundraiserAssignment

作成した基金調達者の割り当て

名前 パス 型 説明
ID
 id string

新しく作成した基金調達者割り当ての ID。

FundraisingApi.CreatedFundAttachment

作成済み資金の添付資料

名前 パス 型 説明
ID
 id string

新しく作成された資金の添付資料の ID。

FundraisingApi.CreatedFundCustomField

作成済み資金のカスタム フィールド

名前 パス 型 説明
ID
 id string

新しく作成された資金のカスタム フィールドの ID。

FundraisingApi.FundraiserAssignmentRead

割り当て

名前 パス 型 説明
ID
 id string

基金調達者割り当てのシステム レコード ID。
スタッフ ID
 constituent_id string

割り当て済みスタッフのシステム レコード ID。
タイプ
 type string

基金調達者の種類。
割り当て開始
 start date-time

割り当ての開始日。
割り当て終了
 end date-time

割り当ての終了日。
値
 amount.value double

金額。
キャンペーン ID
 campaign_id string

ギフトを適用することになる、キャンペーン対象のシステム レコード ID。
資金 ID
 fund_id string

ギフトを適用することになる、資金対象のシステム レコード ID。
訴求力 ID
 appeal_id string

ギフトを適用することになる、異議申し立てのシステム レコード ID。

FundraisingApi.FundAttachmentRead

添付

名前 パス 型 説明
ID
 id string

添付資料のシステム レコード ID。
資金 ID
 parent_id string

添付資料に関連付けられた資金のシステム レコード ID。
タイプ
 type string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル URL
 thumbnail_url string

サムネイルの URL。 画像のみの物理的な添付資料の場合。 アクセスを 60 分に制限する、時間期限付きの署名が含まれます。
コンテンツ タイプ
 content_type string

コンテンツの種類。 物理的な添付資料のみ。
ファイル サイズ
 file_size integer

ファイル サイズ (バイト数)。 物理的な添付資料のみ。

FundraisingApi.FundCustomFieldRead

カスタム フィールド

名前 パス 型 説明
ID
 id string

カスタム フィールドのシステム レコード ID。
資金 ID
 parent_id string

カスタム フィールドに関連付けられた資金のシステム レコード ID。
カテゴリ
 category string

カスタム フィールド カテゴリ。
タイプ
 type string

カスタム フィールドが表すデータの種類。
値
 value

カスタム フィールドの値。
日
 date date

カスタム フィールドの日付。
コメント
 comment string

カスタム フィールドのコメント。 文字数制限: 50。
追加した日付
 date_added date-time

カスタム フィールドが作成された日付。
変更日
 date_modified date-time

カスタム フィールドが最終変更された日付。

FundraisingApi.FundRead

資金

名前 パス 型 説明
ID
 id string

資金のシステム レコード ID。
カテゴリ
 category string

資金のカテゴリ。
追加した日付
 date_added date-time

資金が作成された日付。
変更日
 date_modified date-time

資金が最終変更された日付。
内容
 description string

資金の表示名。
終了日
 end_date date-time

資金の終了日。
値
 goal.value double

金額。
非アクティブ?
 inactive boolean

資金は非アクティブ (現在の日付が任意の開始日より後で、終了日より前) ですか?
検索 ID
 lookup_id string

資金のユーザー定義の識別子。
開始日
 start_date date-time

資金の開始日。
タイプ
 type string

資金の種類。

FundraisingApi.PackageRead

パッケージ

名前 パス 型 説明
ID
 id string

パッケージのシステム レコード ID。
訴求力 ID
 appeal_id string

パッケージに関連付けられた異議申し立てのシステム レコード ID。
カテゴリ
 category string

パッケージのカテゴリ。
追加した日付
 date_added date-time

パッケージが作成された日付。
変更日
 date_modified date-time

パッケージが最終変更しされた日付。
値
 default_gift_amount.value double

金額。
内容
 description string

パッケージの表示名。
終了日
 end date-time

パッケージの終了日。
値
 goal.value double

金額。
非アクティブ?
 inactive boolean

パッケージは非アクティブ (現在の日付が任意の開始日より後で、終了日より前) ですか?
検索 ID
 lookup_id string

パッケージのユーザー定義の識別子。
メモ
notes string

パッケージのメモ。
受信者数
 recipient_count integer

パッケージの受信者の数。
開始日
 start date-time

パッケージの開始日。

GiftApi.AcknowledgementRead

受信確認

名前 パス 型 説明
日付
 date date-time

受信確認に関連付けられた日付。
レター
 letter string

受信確認に関連付けられた文字。
状態
 status string

受信確認のステータス。 有効な値: ACKNOWLEDGED、NEEDSACKNOWLEDGEMENT、DONOTACKNOWLEDGE。

GiftApi.ApiCollectionOfGiftAttachmentRead

Attachments

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of GiftApi.GiftAttachmentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

GiftApi.ApiCollectionOfGiftCustomFieldRead

カスタム フィールド

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of GiftApi.GiftCustomFieldRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

GiftApi.ApiCollectionOfGiftRead

ギフト

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of GiftApi.GiftRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

GiftApi.BatchGiftAddResults

バッチ ギフト エラー レコードのコレクションと、この操作で追加したバッチ ギフトを含みます

名前 パス 型 説明
エラー
 errors array of GiftApi.GiftBatchGiftError

ギフトを追加するバッチ操作に関連するギフトのバッチ エラー
ギフト
 gifts array of GiftApi.BatchGiftRead

ギフトを追加するバッチ操作によって追加したバッチ ギフト コレクション

GiftApi.GiftBatchGiftError

項目をバッチに追加できないようにする例外を表します。

名前 パス 型 説明
影響を受けるフィールド
 affected_field string

エラーの影響を受けるフィールド
バッチ ID
 batch_id string

バッチのシステム レコード ID
例外エラー コード
 exception_error_code integer

例外エラー コード
例外エラー メッセージ
 exception_error_message string

例外エラー メッセージ
例外エラー名
 exception_error_name string

例外エラーの名前
ギフト ID
 gift_id string

贈与のシステム レコード ID
検索 ID
 lookup_id string

このギフトのユーザーが定義した識別子。

GiftApi.BatchGiftRead

バッチ ギフト

名前 パス 型 説明
バッチ ID
 batch_id string

ギフトを追加した対象バッチの ID。
エラー
 errors array of GiftApi.GiftBatchGiftError

バッチ贈与に関連付けられたエラー。
ID
 id string

バッチ贈与のシステム レコード ID。
スタッフ ID
 constituent_id string

ギフトに関連付けられたスタッフのシステム レコード ID。
種類
 type string

ギフトの種類。
サブタイプ
 subtype string

ギフトのサブタイプ。
日付
 date date-time

ギフトの日付。
値
 amount.value double

金額。
値
 balance.value double

金額。
バッチ番号
 batch_number string

このギフトに関連付けられたバッチ番号。
状態
 gift_status string

贈与の状態。
匿名かどうか
 is_anonymous boolean

匿名贈与かどうか
購買者層
 constituency string

ギフトの購買者層。
検索 ID
 lookup_id string

このギフトのユーザーが定義した識別子。
元
 origin string

贈与の発生元。
転記の状態
 post_status string

ギフトの総勘定元帳の転記の状態。 有効な値は、Posted、NotPosted、および DoNotPost です。 post_status を DoNotPost> に設定すると、post_date は null になります。 NotPosted に設定すると、post_date は編集可能なまま必須になります。 Posted に設定すると、post_date は編集不可で必須になります。
転記日
 post_date date-time

一般会計に贈与を転記した日付。
参照
 reference string

ギフトに関する特別な情報 (ギフトに対するモチベーションや、現物ギフトの詳しい説明など) を追跡するメモです。
日
 recurring_gift_status_date.d integer

あいまいな日付で表した日。
月
 recurring_gift_status_date.m integer

あいまいな日付で表した月。
年
 recurring_gift_status_date.y integer

あいまいな日付で表した年。
頻度
 recurring_gift_schedule.frequency string

表示する定期的なギフトの分割頻度。 有効な値は、WEEKLY、EVERY_TWO_WEEKS、EVERY_FOUR_WEEKS、MONTHLY、QUARTERLY、ANNUALLY です。
開始
 recurring_gift_schedule.start_date date-time

定期的な贈与が開始される日付です。
終了
 recurring_gift_schedule.end_date date-time

定期的な贈与の終了日。
値
 gift_aid_amount.value double

金額。
贈与補助の見込み評価の状態
 gift_aid_qualification_status string

この計算フィールドは、税申告情報とデータベース形式に基づいてギフト支援の条件状態を決定します。 有効な値は、Qualified、NotQualified、および PartlyQualified です。 対象は英国のみです。
贈与コード
 gift_code string

贈与に関連付けられたギフト コード値。
贈与の分割
 gift_splits array of GiftApi.GiftSplitRead

このギフトに関連付けられたギフト分割セット。
基金調達者
 fundraisers array of GiftApi.GiftFundraiserRead

贈与のクレジットを受け取る基金調達者セット。
ソフト クレジット
 soft_credits array of GiftApi.SoftCreditRead

贈与に関連付けられたソフト クレジットのセット。
領収書
 receipts array of GiftApi.ReceiptRead

贈与に関連付けられた領収書セット。
確認
 acknowledgements array of GiftApi.AcknowledgementRead

ギフトに関連付けられた確認セット。
支払
 payments array of GiftApi.PaymentRead

贈与の支払。
リンクしている贈与
 linked_gifts array of string

この贈与とリンクしている他の贈与の識別子。
追加した日付
 date_added date-time

ギフトを作成した日。
変更日
 date_modified date-time

ギフトを最後に変更した日。

GiftApi.CreatedGift

作成済みギフト

名前 パス 型 説明
ID
 id string

新しく作成されたギフトの ID。

GiftApi.CreatedGiftAttachment

作成済みギフト添付資料

名前 パス 型 説明
ID
 id string

新しく作成されたギフト添付資料の ID。

GiftApi.CreatedGiftCustomField

作成済みギフトのカスタム フィールド

名前 パス 型 説明
ID
 id string

新しく作成されたギフトのカスタム フィールドの ID。

GiftApi.GiftAttachmentRead

添付

名前 パス 型 説明
ID
 id string

添付資料のシステム レコード ID。
ギフト ID
 parent_id string

添付資料に関連付けられたギフトのシステム レコード ID。
タイプ
 type string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル URL
 thumbnail_url string

サムネイルの URL。 画像のみの物理的な添付資料の場合。 アクセスを 60 分に制限する、時間期限付きの署名が含まれます。
コンテンツ タイプ
 content_type string

コンテンツの種類。 物理的な添付資料のみ。
ファイル サイズ
 file_size integer

ファイル サイズ (バイト数)。 物理的な添付資料のみ。

GiftApi.GiftCustomFieldRead

カスタム フィールド

名前 パス 型 説明
ID
 id string

カスタム フィールドのシステム レコード ID。
ギフト ID
 parent_id string

カスタム フィールドに関連付けられたギフトのシステム レコード ID。
カテゴリ
 category string

カスタム フィールド カテゴリ。
タイプ
 type string

カスタム フィールドが表すデータの種類。
値
 value

カスタム フィールドの値。
日
 date date

カスタム フィールドの日付。
コメント
 comment string

カスタム フィールドのコメント。 文字数制限: 50。
追加した日付
 date_added date-time

カスタム フィールドが作成された日付。
変更日
 date_modified date-time

カスタム フィールドが最終変更された日付。

GiftApi.GiftFundraiserRead

ギフト資金調達者

名前 パス 型 説明
値
 amount.value double

金額。
資金調達者 ID
 constituent_id string

ギフトに関連付けられた資金調達者のスタッフ システム レコード ID。

GiftApi.GiftRead

贈答業

名前 パス 型 説明
ID
 id string

贈与のシステム レコード ID。
スタッフ ID
 constituent_id string

ギフトに関連付けられたスタッフのシステム レコード ID。
タイプ
 type string

ギフトの種類。
サブタイプ
 subtype string

ギフトのサブタイプ。
日
 date date-time

ギフトの日付。
値
 amount.value double

金額。
値
 balance.value double

金額。
バッチ番号
 batch_number string

このギフトに関連付けられたバッチ番号。
ステータス
 gift_status string

贈与の状態。
匿名?
 is_anonymous boolean

匿名贈与かどうか
購買者層
 constituency string

ギフトの購買者層。
検索 ID
 lookup_id string

このギフトのユーザーが定義した識別子。
元
 origin string

贈与の発生元。
転記の状態
 post_status string

ギフトの総勘定元帳の転記の状態。 有効な値は、Posted、NotPosted、および DoNotPost です。 post_status を DoNotPost> に設定すると、post_date は null になります。 NotPosted に設定すると、post_date は編集可能なまま必須になります。 Posted に設定すると、post_date は編集不可で必須になります。
転記日
 post_date date-time

一般会計に贈与を転記した日付。
参照
 reference string

ギフトに関する特別な情報 (ギフトに対するモチベーションや、現物ギフトの詳しい説明など) を追跡するメモです。
日
 recurring_gift_status_date.d integer

あいまいな日付で表した日。
月
 recurring_gift_status_date.m integer

あいまいな日付で表した月。
年
 recurring_gift_status_date.y integer

あいまいな日付で表した年。
頻度
 recurring_gift_schedule.frequency string

表示する定期的なギフトの分割頻度。 有効な値は、WEEKLY、EVERY_TWO_WEEKS、EVERY_FOUR_WEEKS、MONTHLY、QUARTERLY、ANNUALLY です。
開始
 recurring_gift_schedule.start_date date-time

定期的な贈与が開始される日付です。
終了
 recurring_gift_schedule.end_date date-time

定期的な贈与の終了日。
値
 gift_aid_amount.value double

金額。
ギフト支援の条件状態
 gift_aid_qualification_status string

この計算フィールドは、税申告情報とデータベース形式に基づいてギフト支援の条件状態を決定します。 有効な値は、Qualified、NotQualified、および PartlyQualified です。 対象は英国のみです。
ギフト コード
 gift_code string

贈与に関連付けられたギフト コード値。
ギフトの分割
 gift_splits array of GiftApi.GiftSplitRead

このギフトに関連付けられたギフト分割セット。
資金調達者
 fundraisers array of GiftApi.GiftFundraiserRead

贈与のクレジットを受け取る基金調達者セット。
ソフト クレジット
 soft_credits array of GiftApi.SoftCreditRead

贈与に関連付けられたソフト クレジットのセット。
領収書
 receipts array of GiftApi.ReceiptRead

贈与に関連付けられた領収書セット。
確認
 acknowledgements array of GiftApi.AcknowledgementRead

ギフトに関連付けられた確認セット。
支払
 payments array of GiftApi.PaymentRead

贈与の支払。
リンクしている贈与
 linked_gifts array of string

この贈与とリンクしている他の贈与の識別子。
追加した日付
 date_added date-time

ギフトを作成した日。
変更日
 date_modified date-time

ギフトを最後に変更した日。

GiftApi.GiftSplitRead

ギフトの分割

名前 パス 型 説明
ID
 id string

ギフト分割のシステム レコード ID。
値
 amount.value double

金額。
異議申し立て ID
 appeal_id string

贈与分割に関連付けられた異議申し立てのシステム レコード ID。
キャンペーン ID
 campaign_id string

贈与分割に関連付けられたキャンペーンのシステム レコード ID。
資金 ID
 fund_id string

贈与分割に関連付けられた資金のシステム レコード ID。
値
 gift_aid_amount.value double

金額。
贈与補助の見込み評価の状態
 gift_aid_qualification_status string

ギフト分割のギフト支援の条件状態。 有効な値は: Qualified、NotQualified、および NotQualified。 対象は英国のみです。
パッケージ ID
 package_id string

贈与分割に関連付けられたパッケージのシステム レコード ID。

GiftApi.ReceiptRead

入荷

名前 パス 型 説明
値
 amount.value double

金額。
日付
 date date-time

領収書の日付。
数値
 number integer

領収書の番号。
状態
 status string

領収書の状態。 有効な値: RECEIPTED、NEEDSRECEIPT、DONOTRECEIPT。

GiftApi.PaymentRead

支払い

名前 パス 型 説明
アカウント トークン
 account_token string

外部の支払いプロバイダーからトークン化されたアカウント情報 (例: クレジット カード)。 "CreditCard" と "DirectDebit" の支払方法にのみ適用されます。
BBPS 構成 ID
 bbps_configuration_id string

BBPS 構成 ID。 "CreditCard" と "DirectDebit" の支払方法にのみ適用されます。
BBPS トランザクション ID
 bbps_transaction_id string

BBPS トランザクション ID。 "CreditCard" と "DirectDebit" の支払方法にのみ適用されます。
日
 check_date.d integer

あいまいな日付で表した日。
月
 check_date.m integer

あいまいな日付で表した月。
年
 check_date.y integer

あいまいな日付で表した年。
小切手番号
 check_number string

小切手番号。 "PersonalCheck" の支払方法にのみ適用されます。
チェックアウト トランザクション ID
 checkout_transaction_id string

チェックアウト トランザクション ID。 "CreditCard" と "DirectDebit" の支払方法にのみ適用されます。
支払方法
 payment_method string

支払方法。 有効な値を以下に示します。
参照
 reference string

参照。 "その他" の支払方法にのみ適用されます。
日
 reference_date.d integer

あいまいな日付で表した日。
月
 reference_date.m integer

あいまいな日付で表した月。
年
 reference_date.y integer

あいまいな日付で表した年。

GiftApi.SoftCreditRead

ソフト クレジット

名前 パス 型 説明
ID
 id string

ソフト クレジットのシステム レコード ID。
値
 amount.value double

金額。
スタッフ ID
 constituent_id string

ソフト クレジットに関連付けられたスタッフのシステム レコード ID。
ギフト ID
 gift_id string

ソフト クレジットに関連付けられたギフトのシステム レコード ID。

GiftBatchApi.ApiCollectionOfGiftBatch

贈与バッチ

名前 パス 型 説明
カウント
 count integer

応答が含む贈与バッチの合計数。
値
 value array of GiftBatchApi.GiftBatch

応答が含む項目セット。

GiftBatchApi.CreatedBatch

作成した贈与バッチ

名前 パス 型 説明
ID
 batch_id string

新しく作成した贈与バッチのシステム レコード ID。

GiftBatchApi.GiftBatch

贈与バッチ オブジェクトを表します

名前 パス 型 説明
ID
 id string

バッチのシステム レコード ID。
説明
 batch_description string

バッチの説明。
バッチ番号
 batch_number string

バッチ番号
見積もり番号
 projected_number_of_gifts integer

バッチが含む贈与の見積もり件数。
実際の件数
 number_of_gifts integer

バッチが含む実際の贈与件数。
見積もり金額
 projected_amount double

バッチが含む贈与の見積もり価値。
実績金額
 actual_amount double

バッチが含むギフトの実際の価値。
例外があるかどうか
 has_exceptions boolean

バッチに例外があるかどうか
承認済みかどうか
 is_approved boolean

バッチが承認済みかどうか
作成者
 created_by string

バッチを作成したユーザーの名前。
作成日時
 created_on date-time

バッチを作成した日付。

ListApi.CreatedList

作成したリスト

名前 パス 型 説明
ID
 id string

新しく作成するリストの ID。

OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

Attachments

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of OpportunityApi.OpportunityAttachmentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

カスタム フィールド

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of OpportunityApi.OpportunityCustomFieldRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

OpportunityApi.ApiCollectionOfOpportunityRead

営業案件

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of OpportunityApi.OpportunityRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

OpportunityApi.CreatedOpportunity

作成された営業案件

名前 パス 型 説明
ID
 id string

新しく作成された営業案件の ID。

OpportunityApi.CreatedOpportunityAttachment

作成済み営業案件の添付資料

名前 パス 型 説明
ID
 id string

新しく作成された営業案件の添付資料の ID。

OpportunityApi.CreatedOpportunityCustomField

作成済み営業案件の添付資料

名前 パス 型 説明
ID
 id string

新しく作成された営業案件の添付資料の ID。

OpportunityApi.Fundraiser

基金調達者

名前 パス 型 説明
スタッフ ID
 constituent_id string

基金調達者に関連付けられたスタッフのシステム レコード ID。
値
 credit_amount.value double

金額。

OpportunityApi.OpportunityAttachmentRead

添付

名前 パス 型 説明
ID
 id string

添付資料のシステム レコード ID。
営業案件 ID
 parent_id string

添付資料に関連付けられた営業案件のシステム レコード ID。
タイプ
 type string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル URL
 thumbnail_url string

サムネイルの URL。 画像のみの物理的な添付資料の場合。 アクセスを 60 分に制限する、時間期限付きの署名が含まれます。
コンテンツ タイプ
 content_type string

コンテンツの種類。 物理的な添付資料のみ。
ファイル サイズ
 file_size integer

ファイル サイズ (バイト数)。 物理的な添付資料のみ。

OpportunityApi.OpportunityCustomFieldRead

カスタム フィールド

名前 パス 型 説明
ID
 id string

カスタム フィールドのシステム レコード ID。
営業案件 ID
 parent_id string

カスタム フィールドに関連付けられた営業案件のシステム レコード ID。
カテゴリ
 category string

カスタム フィールド カテゴリ。
タイプ
 type string

カスタム フィールドが表すデータの種類。
値
 value

カスタム フィールドの値。
日
 date date

カスタム フィールドの日付。
コメント
 comment string

カスタム フィールドのコメント。 文字数制限: 50。
追加した日付
 date_added date-time

カスタム フィールドが作成された日付。
変更日
 date_modified date-time

カスタム フィールドが最終変更された日付。

OpportunityApi.OpportunityRead

営業案件​​

名前 パス 型 説明
ID
 id string

営業案件のシステム レコード ID。
スタッフ ID
 constituent_id string

営業案件に関連付けられたスタッフのシステム レコード ID。
目的
 purpose string

営業案件の結果として調達された任意の金額の使用目的。
件名
 name string

一覧やスタッフ レコードなど、プログラム全体で営業案件を識別する名前。 文字数制限: 255。
ステータス
 status string

営業案件が要請処理のどこにあるかを示すステータス。
期日
 deadline date-time

営業案件がギフトにつながる目標日。
依頼日
 ask_date date-time

要請が発生した日付。
値
 ask_amount.value double

金額。
予想日
 expected_date date-time

営業案件に応じて見込顧客が提供すると予想される日付。
値
 expected_amount.value double

金額。
資金調達された日付
 funded_date date-time

営業案件に応じて見込顧客が提供した日付。
値
 funded_amount.value double

金額。
キャンペーン ID
 campaign_id string

営業案件に関連付けられたキャンペーンのシステム レコード ID。 キャンペーンでは、資金調達の全体的な目標を設定します。
資金 ID
 fund_id string

営業案件に関連付けられた資金のシステム レコード ID。 資金は、ギフトの特定の財務目的を指定し、そのギフトの財務勘定を識別します。
資金調達者
 fundraisers array of OpportunityApi.Fundraiser

営業案件に割り当てられた資金調達者の一連のシステム レコード ID。
非アクティブ?
 inactive boolean

営業案件は非アクティブですか?
linked_gifts
 linked_gifts array of string

営業案件に関連するギフトのシステム レコードの ID。
追加した日付
 date_added date-time

営業案件が作成された日付。
変更日
 date_modified date-time

営業案件が最終変更された日付。