HubSpot Engagements V2 (独立系発行者) (プレビュー)
HubSpot Engagements は、HubSpot 外で行われたやり取りに関する CRM レコードを最新の状態に保つために使用されます。 CRM のアクティビティ レポートもこのデータを利用します。
このコネクタは、次の製品および地域で利用可能です:
| サービス | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 名前 | Troy Taylor |
| [URL] | https://www.hitachisolutions.com |
| メール | ttaylor@hitachisolutions.com |
| Connector Metadata | |
|---|---|
| 発行者 | Troy Taylor |
| Web サイト | https://www.hubspot.com/products/crm |
| プライバシー ポリシー | https://legal.hubspot.com/privacy-policy |
| カテゴリー | 営業と CRM、コミュニケーション |
HubSpot Engagements V2
HubSpot Engagements は、HubSpot 外で行われたやり取りに関する CRM レコードを最新の状態に保つために使用されます。 CRM のアクティビティ レポートもこのデータを利用します。
公開元: Troy Taylor、Hitachi Solutions
前提条件
HubSpot のアカウントを持ち、スーパー管理者である必要があります。
資格情報の取得
アカウントにログインしたら、「設定 -> アカウント設定 ->統合 ->プライベートアプリ」にアクセスします。 プライベート アプリを作成し、アクションを使用するスコープのみを割り当てる必要があります。 プライベート アプリが作成されると、プライベート アプリの 「認証」 セクションに アクセス トークン が表示されます。
サポートされている操作
呼び出しのバッチを作成する
呼び出しのバッチを作成します。
呼び出しのバッチを取得する
内部 ID または一意のプロパティ値ごとに通話のバッチを取得します。
呼び出しのバッチを更新する
呼び出しのバッチを更新します。
呼び出しのバッチをアーカイブする
ID ごとに呼び出しのバッチをアーカイブします。
呼び出しを一覧表示する
呼び出しのページを取得します。 properties クエリ パラメーターが返す対象を制御します。
呼び出しを作成する
指定されたプロパティとの呼び出しを作成し、ID を含むオブジェクトのコピーを返します。
オブジェクトを読む
callId ごとに識別されたオブジェクトを取得します。 callId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
オブジェクトをアーカイブする
callId ごとに識別されたオブジェクトをごみ箱に移動します。
オブジェクトを更新する
callId ごとに識別されるオブジェクトの部分的な更新を実行します。 callId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
2 つの呼び出しのマージ
同じタイプの 2 つの呼び出しをマージします。
呼び出しを削除する - GDPR
GDPR に従うために、呼び出しおよび関連するすべてのコンテンツを完全に削除します。 email に設定されたオプションのプロパティ idProperty を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
呼び出しの検索
呼び出しの一覧を取得します。
メールのバッチを作成する
メールのバッチを作成します。
メールのバッチを取得する
内部 ID または一意のプロパティ値ごとに、メールのバッチを取得します。
メールのバッチをアーカイブする
ID ごとにメールのバッチをアーカイブします。
メールのバッチを更新する
メールのバッチを更新します。
メールを一覧表示する
メールのページを取得します。 properties クエリ パラメーターが返す対象を制御します。
電子メールを作成する
指定されたプロパティとのメールを作成し、ID を含むオブジェクトのコピーを返します。
電子のメールの取得
emailId ごとに識別されたオブジェクトを取得します。 emailId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
メールをアーカイブする
emailId ごとに識別されたオブジェクトをごみ箱に移動します。
メールを更新する
emailId ごとに識別されるオブジェクトの部分的な更新を実行します。 emailId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
2 つのメールのマージ
同じタイプの 2 つのメールをマージします。
メールの削除 - GDPR
GDPR に従うために、メールおよび関連するすべてのコンテンツを完全に削除します。 email に設定されたオプションのプロパティ idProperty を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
メールアドレスを検索する
メールの一覧を取得します。
会議のバッチを更新する
会議のバッチを更新します。
会議のバッチをアーカイブする
ID ごとに会議のバッチをアーカイブします。
会議のバッチを取得する
内部 ID または一意のプロパティ値ごとに、会議のバッチを取得します。
会議のバッチを作成する
会議のバッチを作成します。
会議を取得する
meetingId ごとに識別されたオブジェクトを取得します。 meetingId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
会議をアーカイブする
meetingId ごとに識別されたオブジェクトをごみ箱に移動します。
会議を更新する
meetingId ごとに識別されるオブジェクトの部分的な更新を実行します。 meetingId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
会議を一覧表示する
会議のページを取得します。 properties クエリ パラメーターが返す対象を制御します。
会議を作成する
指定したプロパティで会議を作成し、ID を含むオブジェクトのコピーを返します。
2 つの会議のマージ
同じタイプの 2 つの会議をマージします。
会議を削除する - GDPR
GDPR に従うために、会議および関連するすべてのコンテンツを完全に削除します。 email に設定されたオプションのプロパティ idProperty を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
会議を検索する
会議の一覧を取得する。
メモのバッチを取得する
内部 ID または一意のプロパティ値ごとにメモのバッチを取得します。
メモのバッチをアーカイブする
ID ごとにメモのバッチをアーカイブします。
メモのバッチを更新する
メモのバッチを更新します。
メモのバッチを作成する
メモのバッチを作成します。
メモを一覧表示する
メモのページを取得します。 properties クエリ パラメーターが返す対象を制御します。
メモを作成
指定されたプロパティとのメモを作成し、ID を含むオブジェクトのコピーを返します。
メモの取得
noteId ごとに識別されたオブジェクトを取得します。 noteId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
メモをアーカイブする
noteId ごとに識別されたオブジェクトをごみ箱に移動します。
メモの更新
noteId ごとに識別されるオブジェクトの部分的な更新を実行します。 noteId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
2 つのメモをマージする
同じタイプの 2 つのメモをマージします。
メモの削除 - GDPR
GDPR に従うために、メモおよび関連するすべてのコンテンツを完全に削除します。 email に設定されたオプションのプロパティ idProperty を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
メモの検索
メモの一覧を取得します。
郵便物のバッチを取得する
内部 ID または一意のプロパティ値ごとに、郵便物のバッチを取得します。
郵便物のバッチをアーカイブする
ID ごとに郵便物のバッチをアーカイブします。
郵便物のバッチを作成する
郵便物のバッチを作成します。
郵便物のバッチを更新する
郵便物のバッチを更新します。
郵便物を一覧表示する
郵便物のページを取得します。 properties クエリ パラメーターが返す対象を制御します。
郵便物を作成する
指定したプロパティで郵便物を作成し、ID を含むオブジェクトのコピーを返します。
郵便物を取得する
postalMailId ごとに識別されたオブジェクトを取得します。 postalMailId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
郵便物をアーカイブする
postalMailId ごとに識別されたオブジェクトをごみ箱に移動します。
郵便物を更新する
postalMailId ごとに識別されるオブジェクトの部分的な更新を実行します。 postalMailId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
2 つの郵便物をマージする
同じタイプの 2 つの郵便物をマージします。
郵便物を削除する - GDPR
GDPR に従うために、郵便物および関連するすべてのコンテンツを完全に削除します。 email に設定されたオプションのプロパティ idProperty を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
郵便物を検索する
郵便物の一覧を取得します。
タスクのバッチをアーカイブする
ID ごとにタスクのバッチをアーカイブします。
タスクのバッチを作成する
タスクのバッチを作成します。
タスクのバッチを更新する
タスクのバッチを更新します。
タスクのバッチを取得する
内部 ID または一意のプロパティ値ごとにタスクのバッチを取得します。
タスクを取得する
taskId ごとに識別されたオブジェクトを取得します。 taskId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
タスクをアーカイブする
taskId ごとに識別されたオブジェクトをごみ箱に移動します。
タスクの更新
taskId ごとに識別されるオブジェクトの部分的な更新を実行します。 taskId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
タスクを一覧表示する
タスクのページを取得します。 properties クエリ パラメーターが返す対象を制御します。
タスクを作成する
指定したプロパティでタスクを作成し、ID を含むオブジェクトのコピーを返します。 標準タスクを作成するためのドキュメントと例が提供されています。
2 つのタスクをマージする
同じタイプの 2 つのタスクをマージします。
タスクを削除する - GDPR
GDPR に従うために、タスクおよび関連するすべてのコンテンツを完全に削除します。 email に設定されたオプションのプロパティ idProperty を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
タスクの検索
タスクの一覧を取得します。
コミュニケーションのバッチを更新する
コミュニケーションのバッチを更新します。
コミュニケーションのバッチをアーカイブする
ID ごとにコミュニケーションのバッチをアーカイブします。
コミュニケーションのバッチを作成する
コミュニケーションのバッチを作成します。
コミュニケーションのバッチを取得する
内部 ID または一意のプロパティ値ごとに、コミュニケーションのバッチを取得します。
コミュニケーションを一覧表示する
コミュニケーションのページを取得します。 properties クエリ パラメーターが返す対象を制御します。
コミュニケーションを作成する
指定したプロパティでコミュニケーションを作成し、ID を含むオブジェクトのコピーを返します。
コミュニケーションを取得する
communicationId ごとに識別されたオブジェクトを取得します。 communicationId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
コミュニケーションをアーカイブする
communicationId ごとに識別されたオブジェクトをごみ箱に移動します。
コミュニケーションを更新する
communicationId ごとに識別されるオブジェクトの部分的な更新を実行します。 communicationId は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
2 つのコミュニケーションをマージする
同じタイプの 2 つのコミュニケーションをマージします。
コミュニケーションを削除する - GDPR
GDPR に従うために、コミュニケーションおよび関連するすべてのコンテンツを完全に削除します。 email に設定されたオプションのプロパティ idProperty を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
コミュニケーションを検索する
コミュニケーションの一覧を取得します。
既知の問題と制限事項
現時点で、既知の問題は発生していません。
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| アクセス トークン ('Bearer YOUR_ACCESS_TOKEN' の形式) | securestring | この API のアクセストークン ('Bearer YOUR_ACCESS_TOKEN' 形式) | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| 2 つのコミュニケーションをマージする |
同じタイプの 2 つのコミュニケーションをマージします。 |
| 2 つのタスクをマージする |
同じタイプの 2 つのタスクをマージします。 |
| 2 つのメモをマージする |
同じタイプの 2 つのメモをマージします。 |
| 2 つのメールのマージ |
同じタイプの 2 つのメールをマージします。 |
| 2 つの会議のマージ |
同じタイプの 2 つの会議をマージします。 |
| 2 つの呼び出しのマージ |
同じタイプの 2 つの呼び出しをマージします。 |
| 2 つの郵便物をマージする |
同じタイプの 2 つの郵便物をマージします。 |
| オブジェクトをアーカイブする |
"callId" ごとに識別されたオブジェクトをごみ箱に移動します。 |
| オブジェクトを更新する |
"callId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "callId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| オブジェクトを読む |
"callId" ごとに識別されたオブジェクトを取得します。 "callId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| コミュニケーションのバッチをアーカイブする |
ID ごとにコミュニケーションのバッチをアーカイブします。 |
| コミュニケーションのバッチを作成する |
コミュニケーションのバッチを作成します。 |
| コミュニケーションのバッチを取得する |
内部 ID または一意のプロパティ値ごとに、コミュニケーションのバッチを取得します。 |
| コミュニケーションのバッチを更新する |
コミュニケーションのバッチを更新します。 |
| コミュニケーションをアーカイブする |
"communicationId" ごとに識別されたオブジェクトをごみ箱に移動します。 |
| コミュニケーションを一覧表示する |
コミュニケーションのページを取得します。 |
| コミュニケーションを作成する |
指定したプロパティでコミュニケーションを作成し、ID を含むオブジェクトのコピーを返します。 |
| コミュニケーションを削除する - GDPR |
GDPR に従うために、コミュニケーションおよび関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。 |
| コミュニケーションを取得する |
"communicationId" ごとに識別されたオブジェクトを取得します。 "communicationId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| コミュニケーションを更新する |
"communicationId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "communicationId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| コミュニケーションを検索する |
コミュニケーションの一覧を取得します。 |
| タスクのバッチをアーカイブする |
ID ごとにタスクのバッチをアーカイブします。 |
| タスクのバッチを作成する |
タスクのバッチを作成します。 |
| タスクのバッチを取得する |
内部 ID または一意のプロパティ値ごとにタスクのバッチを取得します。 |
| タスクのバッチを更新する |
タスクのバッチを更新します。 |
| タスクの更新 |
"taskId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "taskId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| タスクの検索 |
タスクの一覧を取得します。 |
| タスクをアーカイブする |
"taskId" ごとに識別されたオブジェクトをごみ箱に移動します。 |
| タスクを一覧表示する |
タスクのページを取得します。 |
| タスクを作成する |
指定したプロパティでタスクを作成し、ID を含むオブジェクトのコピーを返します。 標準タスクを作成するためのドキュメントと例が提供されています。 |
| タスクを削除する - GDPR |
GDPR に従うために、タスクおよび関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。 |
| タスクを取得する |
"taskId" ごとに識別されたオブジェクトを取得します。 "taskId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| メモのバッチをアーカイブする |
ID ごとにメモのバッチをアーカイブします。 |
| メモのバッチを作成する |
メモのバッチを作成します。 |
| メモのバッチを取得する |
内部 ID または一意のプロパティ値ごとにメモのバッチを取得します。 |
| メモのバッチを更新する |
メモのバッチを更新します。 |
| メモの削除 - GDPR |
GDPR に従うために、メモおよび関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。 |
| メモの取得 |
"noteId" ごとに識別されたオブジェクトを取得します。 "noteId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| メモの更新 |
"noteId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "noteId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| メモの検索 |
メモの一覧を取得します。 |
| メモをアーカイブする |
"noteId" ごとに識別されたオブジェクトをごみ箱に移動します。 |
| メモを一覧表示する |
メモのページを取得します。 |
| メモを作成 |
指定されたプロパティとのメモを作成し、ID を含むオブジェクトのコピーを返します。 |
| メールのバッチをアーカイブする |
ID ごとにメールのバッチをアーカイブします。 |
| メールのバッチを作成する |
メールのバッチを作成します。 |
| メールのバッチを取得する |
内部 ID または一意のプロパティ値ごとに、メールのバッチを取得します。 |
| メールのバッチを更新する |
メールのバッチを更新します。 |
| メールの削除 - GDPR |
GDPR に従うために、メールおよび関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。 |
| メールをアーカイブする |
"emailId" ごとに識別されたオブジェクトをごみ箱に移動します。 |
| メールを一覧表示する |
メールのページを取得します。 |
| メールを更新する |
"emailId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "emailId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| メールアドレスを検索する |
メールの一覧を取得します。 |
| 会議のバッチをアーカイブする |
ID ごとに会議のバッチをアーカイブします。 |
| 会議のバッチを作成する |
会議のバッチを作成します。 |
| 会議のバッチを取得する |
内部 ID または一意のプロパティ値ごとに、会議のバッチを取得します。 |
| 会議のバッチを更新する |
会議のバッチを更新します。 |
| 会議をアーカイブする |
"meetingId" ごとに識別されたオブジェクトをごみ箱に移動します。 |
| 会議を一覧表示する |
会議のページを取得します。 |
| 会議を作成する |
指定したプロパティで会議を作成し、ID を含むオブジェクトのコピーを返します。 |
| 会議を削除する - GDPR |
GDPR に従うために、会議および関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。 |
| 会議を取得する |
"meetingId" ごとに識別されたオブジェクトを取得します。 "meetingId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| 会議を更新する |
"meetingId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "meetingId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| 会議を検索する |
会議の一覧を取得する。 |
| 呼び出しのバッチをアーカイブする |
ID ごとに呼び出しのバッチをアーカイブします。 |
| 呼び出しのバッチを作成する |
呼び出しのバッチを作成します。 |
| 呼び出しのバッチを取得する |
内部 ID または一意のプロパティ値ごとに通話のバッチを取得します。 |
| 呼び出しのバッチを更新する |
呼び出しのバッチを更新します。 |
| 呼び出しの検索 |
呼び出しの一覧を取得します。 |
| 呼び出しを一覧表示する |
呼び出しのページを取得します。 |
| 呼び出しを作成する |
指定されたプロパティとの呼び出しを作成し、ID を含むオブジェクトのコピーを返します。 |
| 呼び出しを削除する - GDPR |
GDPR に従うために、呼び出しおよび関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。 |
| 郵便物のバッチをアーカイブする |
ID ごとに郵便物のバッチをアーカイブします。 |
| 郵便物のバッチを作成する |
郵便物のバッチを作成します。 |
| 郵便物のバッチを取得する |
内部 ID または一意のプロパティ値ごとに、郵便物のバッチを取得します。 |
| 郵便物のバッチを更新する |
郵便物のバッチを更新します。 |
| 郵便物をアーカイブする |
"postalMailId" ごとに識別されたオブジェクトをごみ箱に移動します。 |
| 郵便物を一覧表示する |
郵便物のページを取得します。 |
| 郵便物を作成する |
指定したプロパティで郵便物を作成し、ID を含むオブジェクトのコピーを返します。 |
| 郵便物を削除する - GDPR |
GDPR に従うために、郵便物および関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。 |
| 郵便物を取得する |
"postalMailId" ごとに識別されたオブジェクトを取得します。 "postalMailId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| 郵便物を更新する |
"postalMailId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "postalMailId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| 郵便物を検索する |
郵便物の一覧を取得します。 |
| 電子のメールの取得 |
"emailId" ごとに識別されたオブジェクトを取得します。 "emailId" は、既定で内部オブジェクト ID を参照するか、オプションで |
| 電子メールを作成する |
指定されたプロパティとのメールを作成し、ID を含むオブジェクトのコピーを返します。 |
2 つのコミュニケーションをマージする
同じタイプの 2 つのコミュニケーションをマージします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
マージするオブジェクト ID
|
objectIdToMerge | string |
マージするオブジェクト識別子。 |
|
|
プライマリ オブジェクト ID
|
primaryObjectId | string |
プライマリ オブジェクト識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
2 つのタスクをマージする
同じタイプの 2 つのタスクをマージします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
マージするオブジェクト ID
|
objectIdToMerge | string |
マージするオブジェクト識別子。 |
|
|
プライマリ オブジェクト ID
|
primaryObjectId | string |
プライマリ オブジェクト識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
2 つのメモをマージする
同じタイプの 2 つのメモをマージします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
マージするオブジェクト ID
|
objectIdToMerge | string |
マージするオブジェクト識別子。 |
|
|
プライマリ オブジェクト ID
|
primaryObjectId | string |
プライマリ オブジェクト識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
2 つのメールのマージ
同じタイプの 2 つのメールをマージします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
マージするオブジェクト ID
|
objectIdToMerge | string |
マージするオブジェクト識別子。 |
|
|
プライマリ オブジェクト ID
|
primaryObjectId | string |
プライマリ オブジェクト識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
2 つの会議のマージ
同じタイプの 2 つの会議をマージします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
マージするオブジェクト ID
|
objectIdToMerge | string |
マージするオブジェクト識別子。 |
|
|
プライマリ オブジェクト ID
|
primaryObjectId | string |
プライマリ オブジェクト識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
2 つの呼び出しのマージ
同じタイプの 2 つの呼び出しをマージします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
マージするオブジェクト ID
|
objectIdToMerge | string |
マージするオブジェクト識別子。 |
|
|
プライマリ オブジェクト ID
|
primaryObjectId | string |
プライマリ オブジェクト識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
2 つの郵便物をマージする
同じタイプの 2 つの郵便物をマージします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
マージするオブジェクト ID
|
objectIdToMerge | string |
マージするオブジェクト識別子。 |
|
|
プライマリ オブジェクト ID
|
primaryObjectId | string |
プライマリ オブジェクト識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
オブジェクトをアーカイブする
"callId" ごとに識別されたオブジェクトをごみ箱に移動します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
通話 ID
|
callId | True | string |
呼び出しの識別子。 |
戻り値
- 返答
- string
オブジェクトを更新する
"callId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "callId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
通話 ID
|
callId | True | string |
呼び出しの識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
オブジェクトを読む
"callId" ごとに識別されたオブジェクトを取得します。 "callId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
通話 ID
|
callId | True | string |
呼び出しの識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
コミュニケーションのバッチをアーカイブする
コミュニケーションのバッチを作成する
コミュニケーションのバッチを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
コミュニケーションのバッチを取得する
内部 ID または一意のプロパティ値ごとに、コミュニケーションのバッチを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID
|
id | string |
識別子。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | array of string |
履歴を持つプロパティ。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
コミュニケーションのバッチを更新する
コミュニケーションのバッチを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
コミュニケーションをアーカイブする
"communicationId" ごとに識別されたオブジェクトをごみ箱に移動します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コミュニケーション ID
|
communicationId | True | string |
コミュニケーションの識別子。 |
戻り値
- 返答
- string
コミュニケーションを一覧表示する
コミュニケーションのページを取得します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Limit
|
limit | integer |
制限。 |
|
|
後
|
after | string |
以後。 |
|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
コミュニケーションを作成する
指定したプロパティでコミュニケーションを作成し、ID を含むオブジェクトのコピーを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
コミュニケーションを削除する - GDPR
GDPR に従うために、コミュニケーションおよび関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
オブジェクト識別子。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
- 返答
- string
コミュニケーションを取得する
"communicationId" ごとに識別されたオブジェクトを取得します。 "communicationId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
Communication ID
|
communicationId | True | string |
コミュニケーションの識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
コミュニケーションを更新する
"communicationId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "communicationId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
Communication ID
|
communicationId | True | string |
コミュニケーションの識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
コミュニケーションを検索する
コミュニケーションの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
後
|
after | string |
以後。 |
|
|
Operator
|
operator | string |
演算子です。 |
|
|
プロパティ名
|
propertyName | string |
プロパティの名前。 |
|
|
価値
|
value | string |
値。 |
|
|
最高値
|
highValue | string |
最高値。 |
|
|
Values
|
values | array of string |
値。 |
|
|
Limit
|
limit | string |
制限。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
並べ替え
|
sorts | array of string |
並べ替え。 |
|
|
クエリ
|
query | string |
クエリ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
トータル
|
total | integer |
総数。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
タスクのバッチをアーカイブする
タスクのバッチを作成する
タスクのバッチを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
タスクのバッチを取得する
内部 ID または一意のプロパティ値ごとにタスクのバッチを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID
|
id | string |
識別子。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | array of string |
履歴を持つプロパティ。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
タスクのバッチを更新する
タスクのバッチを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
タスクの更新
"taskId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "taskId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
タスク ID
|
taskId | True | string |
タスクの識別子です。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
タスクの検索
タスクの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
後
|
after | string |
以後。 |
|
|
Operator
|
operator | string |
演算子です。 |
|
|
プロパティ名
|
propertyName | string |
プロパティの名前。 |
|
|
価値
|
value | string |
値。 |
|
|
最高値
|
highValue | string |
最高値。 |
|
|
Values
|
values | array of string |
値。 |
|
|
Limit
|
limit | string |
制限。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
並べ替え
|
sorts | array of string |
並べ替え。 |
|
|
クエリ
|
query | string |
クエリ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
トータル
|
total | integer |
総数。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
タスクをアーカイブする
"taskId" ごとに識別されたオブジェクトをごみ箱に移動します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Task ID
|
taskId | True | string |
タスクの識別子です。 |
戻り値
- 返答
- string
タスクを一覧表示する
タスクのページを取得します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Limit
|
limit | integer |
制限。 |
|
|
後
|
after | string |
以後。 |
|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
タスクを作成する
指定したプロパティでタスクを作成し、ID を含むオブジェクトのコピーを返します。 標準タスクを作成するためのドキュメントと例が提供されています。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
タスクを削除する - GDPR
GDPR に従うために、タスクおよび関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
オブジェクト識別子。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
- 返答
- string
タスクを取得する
"taskId" ごとに識別されたオブジェクトを取得します。 "taskId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
Task ID
|
taskId | True | string |
タスクの識別子です。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
メモのバッチをアーカイブする
メモのバッチを作成する
メモのバッチを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
メモのバッチを取得する
内部 ID または一意のプロパティ値ごとにメモのバッチを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID
|
id | string |
識別子。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | array of string |
履歴を持つプロパティ。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
メモのバッチを更新する
メモのバッチを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
メモの削除 - GDPR
GDPR に従うために、メモおよび関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
オブジェクト識別子。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
- 返答
- string
メモの取得
"noteId" ごとに識別されたオブジェクトを取得します。 "noteId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
メモ ID
|
noteId | True | string |
メモの識別子です。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
メモの更新
"noteId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "noteId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
メモ ID
|
noteId | True | string |
メモの識別子です。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
メモの検索
メモの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
後
|
after | string |
以後。 |
|
|
Operator
|
operator | string |
演算子です。 |
|
|
プロパティ名
|
propertyName | string |
プロパティの名前。 |
|
|
価値
|
value | string |
値。 |
|
|
最高値
|
highValue | string |
最高値。 |
|
|
Values
|
values | array of string |
値。 |
|
|
Limit
|
limit | string |
制限。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
並べ替え
|
sorts | array of string |
並べ替え。 |
|
|
クエリ
|
query | string |
クエリ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
トータル
|
total | integer |
総数。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
メモをアーカイブする
"noteId" ごとに識別されたオブジェクトをごみ箱に移動します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メモ ID
|
noteId | True | string |
メモの識別子です。 |
戻り値
- 返答
- string
メモを一覧表示する
メモのページを取得します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Limit
|
limit | integer |
制限。 |
|
|
後
|
after | string |
以後。 |
|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
メモを作成
指定されたプロパティとのメモを作成し、ID を含むオブジェクトのコピーを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
メールのバッチをアーカイブする
メールのバッチを作成する
メールのバッチを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
メールのバッチを取得する
内部 ID または一意のプロパティ値ごとに、メールのバッチを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID
|
id | string |
識別子。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | array of string |
履歴を持つプロパティ。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
メールのバッチを更新する
メールのバッチを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
メールの削除 - GDPR
GDPR に従うために、メールおよび関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
オブジェクト識別子。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
- 返答
- string
メールをアーカイブする
"emailId" ごとに識別されたオブジェクトをごみ箱に移動します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
戻り値
- 返答
- string
メールを一覧表示する
メールのページを取得します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Limit
|
limit | integer |
制限。 |
|
|
後
|
after | string |
以後。 |
|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
メールを更新する
"emailId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "emailId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
メールアドレスを検索する
メールの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
後
|
after | string |
以後。 |
|
|
Operator
|
operator | string |
演算子です。 |
|
|
プロパティ名
|
propertyName | string |
プロパティの名前。 |
|
|
価値
|
value | string |
値。 |
|
|
最高値
|
highValue | string |
最高値。 |
|
|
Values
|
values | array of string |
値。 |
|
|
Limit
|
limit | string |
制限。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
並べ替え
|
sorts | array of string |
並べ替え。 |
|
|
クエリ
|
query | string |
クエリ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
トータル
|
total | integer |
総数。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
会議のバッチをアーカイブする
会議のバッチを作成する
会議のバッチを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
会議のバッチを取得する
内部 ID または一意のプロパティ値ごとに、会議のバッチを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID
|
id | string |
識別子。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | array of string |
履歴を持つプロパティ。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
会議のバッチを更新する
会議のバッチを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
会議をアーカイブする
"meetingId" ごとに識別されたオブジェクトをごみ箱に移動します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
会議 ID
|
meetingId | True | string |
会議の識別子。 |
戻り値
- 返答
- string
会議を一覧表示する
会議のページを取得します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Limit
|
limit | integer |
制限。 |
|
|
後
|
after | string |
以後。 |
|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
会議を作成する
指定したプロパティで会議を作成し、ID を含むオブジェクトのコピーを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
会議を削除する - GDPR
GDPR に従うために、会議および関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
オブジェクト識別子。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
- 返答
- string
会議を取得する
"meetingId" ごとに識別されたオブジェクトを取得します。 "meetingId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
会議 ID
|
meetingId | True | string |
会議の識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
会議を更新する
"meetingId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "meetingId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
会議 ID
|
meetingId | True | string |
会議の識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
会議を検索する
会議の一覧を取得する。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
後
|
after | string |
以後。 |
|
|
Operator
|
operator | string |
演算子です。 |
|
|
プロパティ名
|
propertyName | string |
プロパティの名前。 |
|
|
価値
|
value | string |
値。 |
|
|
最高値
|
highValue | string |
最高値。 |
|
|
Values
|
values | array of string |
値。 |
|
|
Limit
|
limit | string |
制限。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
並べ替え
|
sorts | array of string |
並べ替え。 |
|
|
クエリ
|
query | string |
クエリ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
トータル
|
total | integer |
総数。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
呼び出しのバッチをアーカイブする
呼び出しのバッチを作成する
呼び出しのバッチを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
呼び出しのバッチを取得する
内部 ID または一意のプロパティ値ごとに通話のバッチを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID
|
id | string |
識別子。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | array of string |
履歴を持つプロパティ。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
呼び出しのバッチを更新する
呼び出しのバッチを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
呼び出しの検索
呼び出しの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
後
|
after | string |
以後。 |
|
|
Operator
|
operator | string |
演算子です。 |
|
|
プロパティ名
|
propertyName | string |
プロパティの名前。 |
|
|
価値
|
value | string |
値。 |
|
|
最高値
|
highValue | string |
最高値。 |
|
|
Values
|
values | array of string |
値。 |
|
|
Limit
|
limit | string |
制限。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
並べ替え
|
sorts | array of string |
並べ替え。 |
|
|
クエリ
|
query | string |
クエリ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
トータル
|
total | integer |
総数。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
呼び出しを一覧表示する
呼び出しのページを取得します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Limit
|
limit | integer |
制限。 |
|
|
後
|
after | string |
以後。 |
|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
呼び出しを作成する
指定されたプロパティとの呼び出しを作成し、ID を含むオブジェクトのコピーを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
呼び出しを削除する - GDPR
GDPR に従うために、呼び出しおよび関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
オブジェクト識別子。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
- 返答
- string
郵便物のバッチをアーカイブする
郵便物のバッチを作成する
郵便物のバッチを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
郵便物のバッチを取得する
内部 ID または一意のプロパティ値ごとに、郵便物のバッチを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID
|
id | string |
識別子。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | array of string |
履歴を持つプロパティ。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
郵便物のバッチを更新する
郵便物のバッチを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了日時
|
completedAt | string |
完了日時。 |
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
状態
|
status | string |
状態。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
郵便物をアーカイブする
"postalMailId" ごとに識別されたオブジェクトをごみ箱に移動します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
郵便物 ID
|
postalMailId | True | string |
郵便物の識別子。 |
戻り値
- 返答
- string
郵便物を一覧表示する
郵便物のページを取得します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Limit
|
limit | integer |
制限。 |
|
|
後
|
after | string |
以後。 |
|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
郵便物を作成する
指定したプロパティで郵便物を作成し、ID を含むオブジェクトのコピーを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
郵便物を削除する - GDPR
GDPR に従うために、郵便物および関連するすべてのコンテンツを完全に削除します。 [email] に設定されたオプションのプロパティ [idProperty] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
オブジェクト識別子。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
戻り値
- 返答
- string
郵便物を取得する
"postalMailId" ごとに識別されたオブジェクトを取得します。 "postalMailId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
郵便物 ID
|
postalMailId | True | string |
郵便物の識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
郵便物を更新する
"postalMailId" ごとに識別されるオブジェクトの部分的な更新を実行します。 "postalMailId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
郵便物 ID
|
postalMailId | True | string |
郵便物の識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
郵便物を検索する
郵便物の一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
後
|
after | string |
以後。 |
|
|
Operator
|
operator | string |
演算子です。 |
|
|
プロパティ名
|
propertyName | string |
プロパティの名前。 |
|
|
価値
|
value | string |
値。 |
|
|
最高値
|
highValue | string |
最高値。 |
|
|
Values
|
values | array of string |
値。 |
|
|
Limit
|
limit | string |
制限。 |
|
|
プロパティ
|
properties | array of string |
プロパティ。 |
|
|
並べ替え
|
sorts | array of string |
並べ替え。 |
|
|
クエリ
|
query | string |
クエリ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
ID
|
results.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
results.archivedAt | string |
アーカイブ日時。 |
|
トータル
|
total | integer |
総数。 |
|
後
|
paging.next.after | string |
以後。 |
|
リンク
|
paging.next.link | string |
リンク。 |
電子のメールの取得
"emailId" ごとに識別されたオブジェクトを取得します。 "emailId" は、既定で内部オブジェクト ID を参照するか、オプションで idProperty クエリ パラメーターで指定された一意のプロパティ値を参照します。 properties クエリ パラメーターが返す対象を制御します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロパティ
|
properties | string |
プロパティ。 |
|
|
履歴を持つプロパティ
|
propertiesWithHistory | string |
履歴を持つプロパティ。 |
|
|
関連付け
|
associations | string |
関連付け。 |
|
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
ID プロパティ
|
idProperty | string |
識別子プロパティ。 |
|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
電子メールを作成する
指定されたプロパティとのメールを作成し、ID を含むオブジェクトのコピーを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
|
関連付けカテゴリ
|
associationCategory | string |
関連付けカテゴリ。 |
|
|
関連付けタイプ ID
|
associationTypeId | string |
関連付けタイプ識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
ID
|
id | string |
識別子。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
アーカイブ済み
|
archived | boolean |
アーカイブ済みかどうか。 |
|
アーカイブ日時
|
archivedAt | string |
アーカイブ日時。 |
定義
文字列
これは基本的なデータ型 '文字列' です。