Docusign
Docusign を使用すると、組織は契約ライフサイクル全体にわたって契約を作成、コミット、管理できます。 顧客は、収益を加速し、リスクを軽減し、ビジネスを運営する契約から価値を引き出すことができます。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Standard | 次を除くすべての Power Automate リージョン : - 21Vianet が運営する China Cloud |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Standard | 次を除くすべての Power Apps リージョン : - 21Vianet が運営する China Cloud |
| Power Automate | Standard | 次を除くすべての Power Automate リージョン : - 21Vianet が運営する China Cloud |
| お問い合わせ | |
|---|---|
| 名前 | docusign |
| URL | https://support.docusign.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | DocuSign, Inc. |
| Web サイト | https://www.docusign.com |
| プライバシー ポリシー | https://www.docusign.com/company/privacy-policy |
| カテゴリ | コンテンツとファイル。生産性 |
Title
DocuSign は、組織が契約の準備、署名、操作、管理を行う方法を接続して自動化するのに役立ちます。 DocuSign Demo コネクタは DocuSign Demo 環境にのみ接続しますが、通常の DocuSign コネクタと同じ機能を提供します。 DocuSign Demo 環境のドキュメントは、法的に拘束力がありません。 デモ以外のすべての用途には、通常の DocuSign コネクタを使用します。
[前提条件]
この統合で Connect トリガーを使用するには、DocuSign アカウントで DocuSign Connect を有効にする必要があります。 既定では有効になっていません。 有効にすると、DocuSign Admin Web アプリケーションから [接続設定] ページにアクセスできます。 この統合で Connect トリガーを使用すると、Webhook が自動的に登録されます。
資格情報の取得
コネクタを試すには、DEMO アカウントを使用してください。
- https://developers.docusign.com/ に移動します。
- サンドボックス アカウントを作成します。
これらは無料試用版とは異なり、期限切れになることがなく、有料アカウント機能の% が 90 件あり、DEMO を通じて送信されたドキュメントは法的に拘束力を持っていません (https://support.docusign.com/en/articles/Free-account-vs-Developer-account)。
コネクタのドキュメント
コネクタに関する詳細なドキュメントについては、 https://support.docusign.com/en/guides/DocuSign-eSignature-for-Microsoft-Power-Automate
既知の問題と制限事項
DocuSign に関する問題については、最初に次のリンクをお試しください: https://support.docusign.com/en/articles/How-Do-I-Open-a-Case-in-the-DocuSign-Support-Center。
デプロイ手順
このコネクタをカスタム コネクタとして Microsoft Power Automate および Power Apps にデプロイするには、 次の手順に従 ってください。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 250 | 60 秒 |
アクション
| [受信者] タブの情報を取得する |
指定された受信者のタブの値を返します。 |
| Copilot: 封筒を一覧表示する |
このアクションにより、封筒の状態、日付範囲、受信者名、受信者の電子メール アドレス、封筒のタイトル、ドキュメント名、または封筒のユーザー設定フィールドの値に基づいて、関連する Docusign 封筒が返されます。 出力は、タイトル、説明、封筒 ID、ドキュメント名、差出人名、封筒の状態、状態の日付、送信日、および Docusign で封筒を表示するためのリンクとして使用できる封筒の URL です。 |
| Copilot: 関連するアクティビティを取得する |
このアクションにより、CRM レコードに関連する Sales Insights が追加され、C4S レコードのサマリー カードに表示されます。 このアクションにより、販売のための副操縦士の既存のスキルが向上します。 |
| Copilot: 関連レコードを取得する |
このアクションは、CRM レコードに関連するレコードを取得します。 このアクションにより、Copilot for Sales の既存のスキルが強化されます。 |
| Docusign Maestro ワークフローを開始する |
Docusign Maestro ワークフローを開始する |
| テンプレートからドキュメント タブを取得する |
テンプレートからドキュメント タブを取得する |
| テンプレートからドキュメントを一覧表示する |
テンプレートからドキュメントを一覧表示する |
| テンプレートをドキュメントに適用する |
テンプレートをドキュメントに適用する |
| テンプレートを一覧表示する |
特定のアカウントのテンプレートを一覧表示します。 |
| テンプレートを使用して封筒を一括送信する |
テンプレートを使用して封筒を一括送信する |
| テンプレートを使用して封筒を作成する |
指定したテンプレートを使用して新しい封筒を作成します。 |
| ビルド番号の表示 (参照のみ。実行用のフローには含めないでください) |
現在デプロイされているビルドの識別子。 |
| ログイン |
ログイン |
| 一括送信リストを作成する |
一括送信リストを作成する |
| 受信者とタブを含むテンプレートを使用して封筒を作成する |
受信者とタブを含むテンプレートを使用して封筒を作成する |
| 受信者に確認の種類を追加する |
受信者に確認の種類を追加します。 |
| 埋め込み署名 URL の生成 (V2) |
埋め込み署名 URL の生成 (V2) |
| 埋め込み署名 URL の生成 [非推奨] |
埋め込み署名 URL の生成 |
| 埋め込み送信者 URL を生成する |
埋め込み送信者 URL を生成する |
| 売上向け Copilot: メールの概要を取得する |
このアクションは、C4S メール サマリー エクスペリエンス内の Outlook のサマリーに表示される追加の Sales Insights を取得します。 このアクションにより、販売のための副操縦士の既存のスキルが向上します。 |
| 売上向け Copilot: 主要な売上を獲得する |
このアクションにより、Outlook サイドカーの C4S キー販売情報カードに表示される追加の販売分析情報が取得されます。 このアクションは、販売のための副操縦士の既存のスキルを強化します |
| 売上向け Copilot: 封筒を一覧表示する |
Copilot for Sales: リスト エンベロープは、タイトル、ドキュメント、受信者、契約状態、送信者名、契約の URL など、Docusign 契約に関する情報を返します。 プラグインは、私が署名する必要があるすべての私の契約や販売注文契約の状態を示すような要求を処理することができます。 |
| 封筒からドキュメント タブを取得する |
封筒からドキュメント タブを取得する |
| 封筒からドキュメントのユーザー設定フィールドを取得する |
封筒からドキュメントのユーザー設定フィールドを取得する |
| 封筒からドキュメントを一覧表示する |
封筒からドキュメントを一覧表示する |
| 封筒からドキュメントを取得する |
封筒からドキュメントを取得する |
| 封筒からドキュメント情報を取得する |
封筒からドキュメント情報を取得する |
| 封筒からドキュメント生成フォーム フィールドを取得する |
封筒からドキュメント生成フォーム フィールドを取得する |
| 封筒からドキュメント生成フォーム フィールドを更新する |
封筒からドキュメント生成フォーム フィールドを更新する |
| 封筒からユーザー設定フィールド情報を取得する |
封筒からユーザー設定フィールド情報を取得する |
| 封筒から受信者を一覧表示する |
封筒から受信者を一覧表示する |
| 封筒から受信者を削除する |
封筒から受信者を削除する |
| 封筒から受信者タブを取得する |
封筒から受信者タブを取得する |
| 封筒から受信者情報を取得する |
封筒から受信者情報を取得する |
| 封筒にドキュメントを追加する |
封筒に文書を追加します。 |
| 封筒に受信者のタブを追加する |
封筒に受信者のタブを追加する |
| 封筒に受信者を追加する (V2) |
封筒に受信者を追加します。 |
| 封筒のアラームを追加する |
封筒のアラームを追加する |
| 封筒のプリフィル タブを更新する |
プリフィル タブの一覧の値を更新する |
| 封筒のユーザー設定フィールドを更新する |
指定した封筒のユーザー設定フィールドの値を更新する |
| 封筒の受信者を更新する |
封筒の受信者を更新する |
| 封筒の受信者タブの値を更新する |
封筒の受信者タブの値を更新する |
| 封筒を一覧表示する |
このアクションにより、封筒の状態、日付範囲、受信者名、受信者の電子メール アドレス、封筒のタイトル、ドキュメント名、または封筒のユーザー設定フィールドの値に基づいて、関連する Docusign 封筒が返されます。 出力は、タイトル、説明、封筒 ID、ドキュメント名、差出人名、封筒の状態、状態の日付、送信日、および Docusign で封筒を表示するためのリンクとして使用できる封筒の URL です。 |
| 封筒を作成する |
新しい空白の封筒を作成します。 |
| 封筒を再送信する |
このアクションは、指定された EnvelopeId に基づいて Docusign 契約に署名する必要がある受信者に、Docusign エンベロープを再送信するか、アラームを受信者に送信します。 |
| 封筒を無効にする |
封筒を無効にします。 |
| 封筒を送信する |
既存の封筒を送信します。 |
| 監査イベント の一覧を取得する |
監査イベント の一覧を取得する |
| 複合テンプレートを使用してエンベロープを作成する |
複合テンプレートを使用してエンベロープを作成する |
| 非推奨: テンプレートを使用してエンベロープを作成する |
指定したテンプレートを使用して新しい封筒を作成します。 |
| 非推奨: 受信者と共にテンプレートを使用して封筒を作成する |
指定したテンプレートを使用して新しい封筒を作成し、受信者を指定します。 |
| 非推奨: 封筒からドキュメントを取得する |
封筒からドキュメントを取得する |
| 非推奨: 封筒に受信者を追加する |
封筒に受信者を追加します。 |
[受信者] タブの情報を取得する
指定された受信者のタブの値を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
受信者 ID
|
recipientId | True | string |
受信者 ID |
|
タブ ラベル
|
tabLabel | True | string |
タブ ラベル |
戻り値
- Body
- Tab
Copilot: 封筒を一覧表示する
このアクションにより、封筒の状態、日付範囲、受信者名、受信者の電子メール アドレス、封筒のタイトル、ドキュメント名、または封筒のユーザー設定フィールドの値に基づいて、関連する Docusign 封筒が返されます。 出力は、タイトル、説明、封筒 ID、ドキュメント名、差出人名、封筒の状態、状態の日付、送信日、および Docusign で封筒を表示するためのリンクとして使用できる封筒の URL です。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
受信者名
|
recipientName | string |
このアクションでは、受信者の名前に基づいて封筒が一覧表示されます |
|
|
Recipient emailId
|
recipientEmailId | string |
このアクションは、受信者の電子メール ID に基づいて封筒を一覧表示します |
|
|
封筒の件名
|
envelopeTitle | string |
このアクションは、封筒の電子メールの件名に基づいて封筒を一覧表示します |
|
|
ユーザー設定フィールド名
|
customFieldName | string |
このアクションでは、ユーザー設定フィールドの名前に基づいて封筒が一覧表示されます |
|
|
ユーザー設定フィールドの値
|
customFieldValue | string |
このアクションは、ユーザー設定フィールドの値に基づいてエンベロープを一覧表示します。 |
|
|
封筒の状態
|
envelopeStatus | string |
このアクションでは、封筒の状態に基づいて封筒が一覧表示されます。 |
|
|
フォルダー
|
folder_ids | string |
このアクションでは、エンベロープのさまざまな状態に基づいてエンベロープが一覧表示されます。 |
|
|
並べ替え
|
order_by | string |
このアクションは、特定のプロパティに基づいて封筒を並べ替えます |
|
|
上
|
top | integer |
返される上位の封筒 |
|
|
スキップ
|
skip | integer |
スキップする封筒 |
|
|
開始日
|
from_date | date-time |
ユーザーが値を指定しない場合は、「'」と入力します。 2017-05-02T01:44Z のパターンまたは形式で開始日時を入力します。 |
|
|
終了日
|
to_date | date-time |
ユーザーが値を指定しない場合は、「'」と入力します。 2017-05-02T01:44Z のパターンまたは形式で終了日時を入力します。 |
戻り値
Copilot: 関連するアクティビティを取得する
このアクションにより、CRM レコードに関連する Sales Insights が追加され、C4S レコードのサマリー カードに表示されます。 このアクションにより、販売のための副操縦士の既存のスキルが向上します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコード タイプ
|
recordType | True | string |
この入力は、分析情報が要求される CRM 内のエンティティまたはオブジェクト タイプを示します。 |
|
レコード ID
|
recordId | True | string |
この入力は、分析情報が要求される CRM レコードの一意識別子を示します。 |
|
開始日
|
startDateTime | date-time |
この入力は、要求された分析情報の開始日時を示します。 |
|
|
終了日
|
endDateTime | date-time |
この入力は、要求された分析情報の終了日時を示します。 |
|
|
上
|
top | integer |
この入力は、取得する分析情報の数を示します。 |
|
|
スキップ
|
skip | integer |
この入力は、スキップする分析情報の数を示します。 |
|
|
CRM の種類
|
crmType | string |
この入力は、分析情報が要求される既存の CRM レコードの CRM のタイプを示します。 |
|
|
CRM 組織の URL
|
crmOrgUrl | string |
この入力は、分析情報が要求される既存の CRM レコードの CRM 環境の URL を示します。 |
戻り値
Copilot: 関連レコードを取得する
このアクションは、CRM レコードに関連するレコードを取得します。 このアクションにより、Copilot for Sales の既存のスキルが強化されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコード タイプ
|
recordType | True | string |
この入力は、関連レコードが要求される CRM のレコードタイプを識別します。 |
|
レコード ID
|
recordId | True | string |
この入力は、関連レコードが要求される CRM レコードの一意識別子を提供します。 |
|
開始日
|
startDateTime | date-time |
開始日時を 2017-05-02T01:44Z の形式で入力します |
|
|
上
|
top | integer |
この入力は、フェッチする関連レコードの数を示します。 |
|
|
スキップ
|
skip | integer |
この入力は、関連レコードをフェッチするときにスキップするレコードの数を示します。 |
|
|
CRM の種類
|
crmType | string |
この入力は、関連レコードがフェッチされる CRM の種類を示します。 |
|
|
CRM 組織の URL
|
crmOrgUrl | string |
この入力は、関連レコードがフェッチされる CRM 環境の URL を示します。 |
戻り値
Docusign Maestro ワークフローを開始する
Docusign Maestro ワークフローを開始する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
ワークフロー
|
workflowId | True | string |
ワークフロー ID を入力するか、ドロップダウンからワークフロー名を選択します |
|
インスタンス名
|
instanceName | True | string |
Maestro ワークフロー インスタンスの名前 |
|
変数
|
variable | dynamic |
戻り値
TriggerMaestroFlowResponse
- response
- object
テンプレートからドキュメント タブを取得する
テンプレートからドキュメント タブを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Template
|
templateId | True | string |
テンプレート ID |
|
ドキュメント ID
|
documentId | True | string |
ドキュメント ID |
戻り値
- Body
- ListTabsResponse
テンプレートからドキュメントを一覧表示する
テンプレートからドキュメントを一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Template
|
templateId | True | string |
テンプレート ID |
戻り値
テンプレートをドキュメントに適用する
テンプレートをドキュメントに適用する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
封筒 ID
|
envelopeId | True | string |
封筒 ID |
|
Template
|
templateId | True | string |
Template |
|
テンプレートの受信者を保持する
|
preserve_template_recipient | string |
いいえ |
|
|
ドキュメント ID
|
documentId | True | string |
ドキュメント ID |
|
ドキュメントの開始ページ
|
documentStartPage | True | string |
ドキュメントの開始ページ |
|
ドキュメントの終了ページ
|
documentEndPage | True | string |
ドキュメントの終了ページ |
テンプレートを一覧表示する
特定のアカウントのテンプレートを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
戻り値
テンプレートを使用して封筒を一括送信する
テンプレートを使用して封筒を一括送信する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
一括送信リスト GUID
|
bulkSendListId | True | string |
一括送信リスト GUID |
|
テンプレート識別子
|
envelopeOrTemplateId | True | string |
テンプレート ID を入力するか、ドロップダウンからテンプレートを選択します |
戻り値
- Body
- BulkSendListGuid
テンプレートを使用して封筒を作成する
指定したテンプレートを使用して新しい封筒を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Template
|
templateId | True | string |
テンプレート ID |
|
封筒の状態
|
status | True | string |
封筒の状態 |
戻り値
ビルド番号の表示 (参照のみ。実行用のフローには含めないでください)
ログイン
一括送信リストを作成する
一括送信リストを作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
一括送信リスト名
|
name | True | string |
一括送信リスト名 |
|
CSV ファイル
|
csv | string |
CSV ファイルのアップロード |
戻り値
- Body
- BulkSendListGuid
受信者とタブを含むテンプレートを使用して封筒を作成する
受信者とタブを含むテンプレートを使用して封筒を作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Template
|
templateId | True | string |
テンプレート識別子 |
|
受取人
|
recipients | dynamic |
ドキュメントの署名者。 |
|
|
メール件名
|
emailSubject | string |
メール件名 |
戻り値
受信者に確認の種類を追加する
受信者に確認の種類を追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
受信者 ID
|
recipientId | True | string |
受信者 ID |
|
受信者の種類
|
recipientType | True | string |
受信者の種類 |
|
検証の種類
|
verificationType | True | string |
検証の種類 |
|
その他の受信者データ
|
additionalRecipientData | dynamic |
その他の受信者データ。 |
埋め込み署名 URL の生成 (V2)
埋め込み署名 URL の生成 (V2)
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
これは対人署名者ですか?
|
isInPersonSigner | True | string |
はい/いいえ |
|
認証方法
|
authenticationMethod | True | string |
認証方法 |
|
戻り URL
|
returnUrl | True | string |
戻り URL |
|
追加された URL
|
additionalURL | True | dynamic |
追加の URL。 |
戻り値
埋め込み署名 URL の生成 [非推奨]
埋め込み署名 URL の生成
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
署名者名
|
signerName | True | string |
署名者名 |
|
署名者の電子メール
|
signerEmail | True | string |
署名者の電子メール |
|
クライアント ユーザー ID
|
clientUserId | string |
署名者が対人でない限り、必須。 対人署名者の場合は空白のままにします |
|
|
認証方法
|
authenticationMethod | True | string |
認証方法 |
|
戻り URL
|
returnUrl | True | string |
戻り URL |
|
追加された URL
|
additionalURL | dynamic |
追加の URL。 |
戻り値
埋め込み送信者 URL を生成する
埋め込み送信者 URL を生成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
で開く
|
openIn | True | string |
で開く |
|
戻り URL
|
returnUrl | True | string |
戻り URL |
|
追加された URL
|
additionalURL | dynamic |
追加の URL。 |
戻り値
売上向け Copilot: メールの概要を取得する
このアクションは、C4S メール サマリー エクスペリエンス内の Outlook のサマリーに表示される追加の Sales Insights を取得します。 このアクションにより、販売のための副操縦士の既存のスキルが向上します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコード タイプ
|
recordType | string |
この入力は、集約された電子メールに関連する CRM のレコードタイプを識別します。 |
|
|
レコード ID
|
recordId | string |
この入力は、要約された電子メールに関連する CRM レコードの一意識別子を提供します。 |
|
|
CRM の種類
|
crmType | string |
この入力は、集計された電子メールに関連するレコードが存在する CRM の種類を示します。 |
|
|
CRM 組織の URL
|
crmOrgUrl | string |
この入力は、要約された電子メールに関連するレコードが存在する CRM 環境の URL を示します。 |
|
|
コンマ区切りのメール アドレス
|
emailContacts | True | string |
この入力は、現在のメール スレッド内のすべての関連する参加者メールの一覧を示します。 |
|
上
|
top | integer |
この入力は、取得する分析情報の数を示します。 |
|
|
スキップ
|
skip | integer |
この入力は、分析情報をフェッチするときにスキップする項目の数を示します。 |
戻り値
- Body
- EmailSummaryResponse
売上向け Copilot: 主要な売上を獲得する
このアクションにより、Outlook サイドカーの C4S キー販売情報カードに表示される追加の販売分析情報が取得されます。 このアクションは、販売のための副操縦士の既存のスキルを強化します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコード タイプ
|
recordType | True | string |
この入力は、主要な販売情報が要求される CRM のレコードタイプを識別します。 |
|
レコード ID
|
recordId | True | string |
この入力は、重要な販売情報が要求される CRM レコードの一意識別子を提供します。 |
|
開始日
|
startDateTime | date-time |
開始日時を 2017-05-02T01:44Z の形式で入力します |
|
|
上
|
top | integer |
この入力値は、フェッチする売上ハイライトの数を示します。 |
|
|
スキップ
|
skip | integer |
この数値は、販売ハイライトを取得する際にスキップする項目の数を示します。 |
|
|
CRM の種類
|
crmType | string |
この入力は、CRM レコードが存在する CRM の種類を示します。このタイプのキー販売情報が要求されます。 |
|
|
CRM 組織の URL
|
crmOrgUrl | string |
この入力は、CRM レコードが存在する CRM 環境の URL を示します。この URL には、主要な販売情報が要求されます。 |
戻り値
- Body
- KeySalesResponse
売上向け Copilot: 封筒を一覧表示する
Copilot for Sales: リスト エンベロープは、タイトル、ドキュメント、受信者、契約状態、送信者名、契約の URL など、Docusign 契約に関する情報を返します。 プラグインは、私が署名する必要があるすべての私の契約や販売注文契約の状態を示すような要求を処理することができます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
受信者名
|
recipientName | string |
このアクションでは、受信者の名前に基づいて封筒が一覧表示されます |
|
|
Recipient emailId
|
recipientEmailId | string |
このアクションは、受信者の電子メール ID に基づいて封筒を一覧表示します |
|
|
封筒の件名
|
envelopeTitle | string |
このアクションは、封筒の電子メールの件名に基づいて封筒を一覧表示します |
|
|
ユーザー設定フィールド名
|
customFieldName | string |
このアクションでは、ユーザー設定フィールドの名前に基づいて封筒が一覧表示されます |
|
|
ユーザー設定フィールドの値
|
customFieldValue | string |
このアクションは、ユーザー設定フィールドの値に基づいてエンベロープを一覧表示します。 |
|
|
封筒の状態
|
envelopeStatus | string |
このアクションでは、封筒の状態に基づいて封筒が一覧表示されます。 |
|
|
フォルダー
|
folder_ids | string |
このアクションでは、エンベロープのさまざまな状態に基づいてエンベロープが一覧表示されます。 |
|
|
並べ替え
|
order_by | string |
このアクションは、特定のプロパティに基づいて封筒を並べ替えます |
|
|
上
|
top | integer |
返される上位の封筒 |
|
|
スキップ
|
skip | integer |
スキップする封筒 |
|
|
開始日
|
startDateTime | date-time |
開始日時を 2017-05-02T01:44Z の形式で入力します |
|
|
終了日
|
endDateTime | date-time |
終了日時を 2017-05-02T01:44Z の形式で入力します |
戻り値
封筒からドキュメント タブを取得する
封筒からドキュメント タブを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
ドキュメント ID
|
documentId | True | string |
ドキュメント ID |
戻り値
- Body
- ListTabsResponse
封筒からドキュメントのユーザー設定フィールドを取得する
封筒からドキュメントのユーザー設定フィールドを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
ドキュメント ID
|
documentId | True | string |
ドキュメント ID |
戻り値
封筒からドキュメントを一覧表示する
封筒からドキュメントを一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
戻り値
封筒からドキュメントを取得する
封筒からドキュメントを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
出力形式
|
documentId | True | string |
特定のドキュメント ID を指定するか、ドロップダウンから出力形式を使用する |
戻り値
- response
- GetDocumentsResponse
封筒からドキュメント情報を取得する
封筒からドキュメント情報を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
ドキュメント名
|
documentName | True | string |
拡張子を持つファイル名 |
戻り値
- Body
- EnvelopeDocument
封筒からドキュメント生成フォーム フィールドを取得する
封筒からドキュメント生成フォーム フィールドを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
戻り値
封筒からドキュメント生成フォーム フィールドを更新する
封筒からドキュメント生成フォーム フィールドを更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
ドキュメント GUID
|
documentGuid | True | string |
ドキュメント GUID |
|
タイプ
|
fieldType | string |
更新するドキュメント生成フィールドの種類を選択する |
|
|
名前
|
name | string |
フィールド名またはテーブルの列名を入力します |
|
|
価値
|
value | string |
フィールド データを入力する |
|
|
: テーブル名
|
tableName | string |
'テーブル行' に必要です。 テーブル名を入力します。 |
|
|
: テーブル行
|
rowNumber | string |
'テーブル行' に必要です。 行番号を入力します |
封筒からユーザー設定フィールド情報を取得する
封筒からユーザー設定フィールド情報を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
ユーザー設定フィールド名
|
fieldName | True | string |
ユーザー設定フィールド名 |
戻り値
封筒から受信者を一覧表示する
封筒から受信者を一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
フォルダー
|
folderId | True | string |
フォルダー ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
戻り値
封筒から受信者を削除する
封筒から受信者を削除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
フォルダー
|
folderId | True | string |
フォルダー ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
Recipient
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
受信者 ID |
戻り値
封筒から受信者タブを取得する
封筒から受信者タブを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
受信者 ID
|
recipientId | True | string |
受信者 ID |
戻り値
封筒から受信者情報を取得する
封筒から受信者情報を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
受信者の電子メール
|
recipientEmail | string |
受信者の電子メール |
|
|
市外局番
|
areaCode | string |
受信者の面番号 |
|
|
電話番号
|
phoneNumber | string |
受信者の電話番号 |
|
|
受信者 ID
|
recipientId | string |
Recipinet Id |
戻り値
- Body
- Signer
封筒にドキュメントを追加する
封筒に文書を追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
ドキュメント Base64 *
|
documentBase64 | True | string |
ドキュメント コンテンツの Base64 |
|
ドキュメントの種類 *
|
fileExtension | True | string |
pdf、docx など |
|
ドキュメント名 *
|
name | True | string |
ドキュメント名 |
|
Pdf フィールドの変換
|
transformPdfFields | string |
いいえ |
|
|
受信者にタブを割り当てる
|
assignTabsToRecipientId | string |
受信者 ID |
戻り値
- Body
- AddDocumentsResponse
封筒に受信者のタブを追加する
封筒に受信者のタブを追加する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
Recipient
|
recipientId | True | string |
受信者 ID |
|
タブの種類
|
tabType | True | string |
タブの種類 |
|
タブの詳細
|
tabDetails | True | dynamic |
選択したアンカー タブの詳細。 |
戻り値
封筒に受信者を追加する (V2)
封筒に受信者を追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
受信者の種類
|
recipientType | True | string |
受信者の種類 |
|
クライアント ユーザー ID
|
clientUserId | string |
埋め込み署名者のクライアント ユーザー ID |
|
|
埋め込み受信者の開始 URL
|
embeddedRecipientStartURL | string |
埋め込み受信者をリダイレクトするための送信者が指定した URL 文字列。 |
|
|
署名順序
|
routingOrder | string |
受信者の署名順序。 |
|
|
電子メール通知言語
|
emailNotificationLanguage | string |
電子メール通知の言語。 |
|
|
電子メール通知の件名
|
emailNotificationSubject | string |
電子メール通知の件名。 |
|
|
電子メール通知本文
|
emailNotificationBody | string |
電子メール通知の本文。 |
|
|
注
|
note | string |
受信者のカスタム メモ。 |
|
|
役割名
|
roleName | string |
受信者に関連付けられているロール名。 |
|
|
SMS 国コード
|
countryCode | integer |
SMS 通知の場合は、先頭に + 記号を付けずに国コード。 |
|
|
SMS 電話番号
|
phoneNumber | integer |
署名者の電子メールまたは SMS 電話が必要です。 電話番号の国コードを除外します。 |
|
|
署名グループ
|
signingGroupId | string |
署名グループ |
|
|
署名の種類
|
signatureType | string |
DocuSign 標準ベースの署名 (SBS) 型。 |
|
|
検証ワークフロー
|
workflowId | string |
ここでは、ペン署名の種類を持つ IDV ワークフローを選択する必要があります。 |
|
|
選択した受信者の種類の詳細
|
additionalRecipientParams | dynamic |
選択した受信者の種類の詳細。 |
戻り値
- Body
- Signer
封筒のアラームを追加する
封筒のアラームを追加する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
アラームが有効
|
reminderEnabled | True | boolean |
false に設定すると、アラームは無効になります。 既定値は false です。 |
|
アラームの遅延
|
reminderDelay | True | string |
受信者がアラームメールを受信するまでの日数を追加します。 |
|
アラームの頻度
|
reminderFrequency | True | string |
アラームメール間の日数を追加します。 |
|
期限切れ後
|
expireAfter | string |
有効期限の日数を追加します。 |
戻り値
- Body
- AddRemindersResponse
封筒のプリフィル タブを更新する
プリフィル タブの一覧の値を更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
ドキュメント ID
|
documentId | True | string |
ドキュメント ID |
|
タイプ
|
tabType | string |
タイプ |
|
|
ID (アイディー)
|
tabId | string |
ID (アイディー) |
|
|
価値
|
value | string |
価値 |
封筒のユーザー設定フィールドを更新する
指定した封筒のユーザー設定フィールドの値を更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
フィールド ID
|
fieldId | True | string |
ユーザー設定フィールド ID |
|
フィールドの型
|
fieldType | True | string |
ユーザー設定フィールドの種類 |
|
名前
|
name | True | string |
ユーザー設定フィールド名 |
|
価値
|
value | True | string |
ユーザー設定フィールドの値 |
戻り値
封筒の受信者を更新する
封筒の受信者を更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
受信者 ID
|
recipientId | True | string |
受信者 ID |
|
署名の種類
|
signatureType | string |
DocuSign 標準ベースの署名 (SBS) 型。 |
|
|
受信者の種類
|
recipientType | True | string |
受信者の種類 |
|
クライアント ユーザー ID
|
clientUserId | string |
埋め込み署名者のクライアント ユーザー ID |
|
|
埋め込み受信者の開始 URL
|
embeddedRecipientStartURL | string |
埋め込み受信者をリダイレクトするための送信者が指定した URL 文字列。 |
|
|
署名順序
|
routingOrder | string |
受信者の署名順序。 |
|
|
電子メール通知言語
|
emailNotificationLanguage | string |
電子メール通知の言語。 |
|
|
電子メール通知の件名
|
emailNotificationSubject | string |
電子メール通知の件名。 |
|
|
電子メール通知本文
|
emailNotificationBody | string |
電子メール通知の本文。 |
|
|
注
|
note | string |
受信者のカスタム メモ。 |
|
|
役割名
|
roleName | string |
受信者に関連付けられているロール名。 |
|
|
SMS 国コード
|
countryCode | integer |
SMS 通知の場合は、先頭に + 記号を付けずに国コード。 |
|
|
SMS 電話番号
|
phoneNumber | integer |
署名者の電子メールまたは SMS 電話が必要です。 電話番号の国コードを除外します。 |
|
|
署名グループ
|
signingGroupId | string |
署名グループ |
|
|
選択した受信者の種類の詳細
|
additionalRecipientParams | dynamic |
選択した受信者の種類の詳細。 |
戻り値
- Body
- Signer
封筒の受信者タブの値を更新する
封筒の受信者タブの値を更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
Recipient
|
recipientId | True | string |
受信者 ID |
|
タイプ
|
tabType | string |
タブの種類 |
|
|
ID (アイディー)
|
tabId | string |
ID (アイディー) |
|
|
価値
|
value | string |
価値 |
封筒を一覧表示する
このアクションにより、封筒の状態、日付範囲、受信者名、受信者の電子メール アドレス、封筒のタイトル、ドキュメント名、または封筒のユーザー設定フィールドの値に基づいて、関連する Docusign 封筒が返されます。 出力は、タイトル、説明、封筒 ID、ドキュメント名、差出人名、封筒の状態、状態の日付、送信日、および Docusign で封筒を表示するためのリンクとして使用できる封筒の URL です。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
受信者名
|
recipientName | string |
このアクションでは、受信者の名前に基づいて封筒が一覧表示されます |
|
|
受信者の電子メール
|
recipientEmailId | string |
受信者のメールで封筒をフィルター処理する |
|
|
封筒の件名
|
envelopeTitle | string |
封筒の件名で封筒をフィルター処理する |
|
|
ユーザー設定フィールド名
|
customFieldName | string |
このアクションでは、ユーザー設定フィールドの名前に基づいて封筒が一覧表示されます |
|
|
ユーザー設定フィールドの値
|
customFieldValue | string |
ユーザー設定フィールド値によるフィルター処理 |
|
|
封筒の状態
|
envelopeStatus | string |
このアクションでは、封筒の状態に基づいて封筒が一覧表示されます。 |
|
|
フォルダー
|
folder_ids | string |
選択したフォルダーでエンベロープをフィルター処理する |
|
|
並べ替え
|
order_by | string |
選択した順序で封筒を並べ替えます |
|
|
封筒を返却する
|
top | integer |
返す封筒の数を指定します (既定値は 10、最大値は 1,000) |
|
|
封筒をスキップする
|
skip | integer |
最初からスキップする封筒の数を指定する |
|
|
開始日
|
from_date | date-time |
開始日時を UTC 形式で入力します:2017-05-02T01:44z |
|
|
終了日
|
to_date | date-time |
終了日時を UTC 形式で入力します:2017-05-02T01:44z。 |
戻り値
封筒を作成する
新しい空白の封筒を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
メール件名
|
emailSubject | True | string |
メールの件名。 |
|
電子メールの本文
|
emailBody | string |
電子メールの本文。 |
|
|
ユーザー設定フィールド
|
accountCustomFields | dynamic |
アカウント レベルで設定されたユーザー設定フィールドを取得します。 |
戻り値
封筒を再送信する
このアクションは、指定された EnvelopeId に基づいて Docusign 契約に署名する必要がある受信者に、Docusign エンベロープを再送信するか、アラームを受信者に送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Envelope
|
envelopeId | True | string |
封筒 ID |
戻り値
- response
- object
封筒を無効にする
封筒を無効にします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
無効な理由
|
voidedReason | True | string |
無効な理由 |
戻り値
- response
- object
封筒を送信する
既存の封筒を送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
戻り値
- response
- object
監査イベント の一覧を取得する
監査イベント の一覧を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
戻り値
- response
- object
複合テンプレートを使用してエンベロープを作成する
複合テンプレートを使用してエンベロープを作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
メール件名
|
emailSubject | True | string |
メールの件名。 |
|
電子メールの本文
|
emailBody | string |
電子メールの本文。 |
|
|
封筒の状態
|
status | True | string |
封筒の状態 |
|
body
|
body | dynamic |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
封筒 ID
|
envelopeId | string |
封筒の ID。 |
|
ステータス
|
status | string |
封筒の状態。 |
|
状態の日付時刻
|
statusDateTime | string |
状態が設定された日時。 |
|
URI
|
uri | string |
DocuSign 内のエンベロープの URI。 |
非推奨: テンプレートを使用してエンベロープを作成する
指定したテンプレートを使用して新しい封筒を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Template
|
templateId | True | string |
テンプレート ID |
|
封筒の状態
|
status | True | string |
封筒の状態 |
|
ユーザー設定フィールド
|
accountCustomFields | True | dynamic |
アカウント レベルで設定されたユーザー設定フィールドを取得します。 |
戻り値
非推奨: 受信者と共にテンプレートを使用して封筒を作成する
指定したテンプレートを使用して新しい封筒を作成し、受信者を指定します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
封筒の状態
|
status | True | string |
封筒の状態 |
|
Template
|
templateId | True | string |
テンプレート ID |
|
署名
|
signers | dynamic |
ドキュメントの署名者。 |
|
|
メール件名
|
emailSubject | string |
メール件名 |
|
|
電子メールの本文
|
emailBody | string |
電子メールの本文 |
戻り値
非推奨: 封筒からドキュメントを取得する
封筒からドキュメントを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
完了証明書
|
certificate | True | boolean |
false に設定すると、エンベロープ署名証明書がダウンロードから削除されます。 |
戻り値
- response
- GetDocumentsResponse
非推奨: 封筒に受信者を追加する
封筒に受信者を追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
Envelope
|
envelopeId | True | string |
封筒 ID |
|
署名者名
|
AddRecipientToEnvelopeName | True | string |
受信者の名前。 |
|
署名者の電子メール
|
AddRecipientToEnvelopeEmail | True | string |
受信者の電子メール。 |
|
署名順序
|
routingOrder | string |
ドキュメント内の受信者の署名順序。 |
|
|
Role
|
roleName | string |
署名者の役割。 |
戻り値
トリガー
| 封筒の状態が変更されたとき (接続) (V3) |
エンベロープの状態が変化したときに、新しいフローをトリガーします。 |
| 非推奨: 封筒の状態が変更されたとき (接続) |
エンベロープの状態が変化したときに、新しいフローをトリガーします。 |
| 非推奨: 封筒の状態が変更されたとき (接続) (V2) |
エンベロープの状態が変化したときに、新しいフローをトリガーします。 |
封筒の状態が変更されたとき (接続) (V3)
エンベロープの状態が変化したときに、新しいフローをトリガーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
接続名
|
name | True | string | |
|
エンベロープ イベント
|
envelopeEvents | True | string |
戻り値
非推奨: 封筒の状態が変更されたとき (接続)
エンベロープの状態が変化したときに、新しいフローをトリガーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
接続名
|
name | True | string | |
|
エンベロープ イベント
|
envelopeEvents | True | string |
戻り値
非推奨: 封筒の状態が変更されたとき (接続) (V2)
エンベロープの状態が変化したときに、新しいフローをトリガーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
アカウント ID |
|
接続名
|
name | True | string | |
|
エンベロープ イベント
|
envelopeEvents | True | string |
戻り値
定義
WebhookEnvelopeResponseV2
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー設定フィールド
|
data.envelopeSummary.customFields | object |
このエンベロープのユーザー設定フィールドを表すキーと値のペア (キーはフィールド名、値はフィールド値)。 |
|
エンベロープ作成 Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
封筒 ID
|
data.envelopeSummary.envelopeId | string | |
|
封筒の送信 Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
封筒の状態
|
data.envelopeSummary.status | string | |
|
電子メールの件名
|
data.envelopeSummary.emailSubject | string | |
|
送信者の名前
|
data.envelopeSummary.sender.userName | string | |
|
送信者のユーザー ID
|
data.envelopeSummary.sender.userId | string | |
|
送信者のアカウント ID
|
data.envelopeSummary.sender.accountId | string | |
|
送信者のメール アドレス
|
data.envelopeSummary.sender.email | string | |
|
署名
|
data.envelopeSummary.recipients.signers | array of object | |
|
タブ
|
data.envelopeSummary.recipients.signers.tabs | object |
この受信者のタブを表すキーと値のペア (ここで、キーはフィールド名、値はフィールド値)。 |
|
受信者の電子メール
|
data.envelopeSummary.recipients.signers.email | string | |
|
受信者 ID
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
ルーティング順序
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Recipient Sent Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
受信者の状態
|
data.envelopeSummary.recipients.signers.status | string |
受信者の状態。 |
|
受信者の種類
|
data.envelopeSummary.recipients.signers.recipientType | string |
受信者の種類。 |
|
検証の種類
|
data.envelopeSummary.recipients.signers.verificationType | string |
検証の種類。 |
|
受信者名
|
data.envelopeSummary.recipients.signers.name | string |
受信者の名前。 |
WebhookEnvelopeResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー設定フィールド
|
customFields | object |
このエンベロープのユーザー設定フィールドを表すキーと値のペア (キーはフィールド名、値はフィールド値)。 |
|
エンベロープ作成 Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Created | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
送信者のメール アドレス
|
DocuSignEnvelopeInformation.EnvelopeStatus.Email | string | |
|
封筒 ID
|
DocuSignEnvelopeInformation.EnvelopeStatus.EnvelopeID | string | |
|
送信者の IP アドレス
|
DocuSignEnvelopeInformation.EnvelopeStatus.SenderIPAddress | string | |
|
封筒の送信 Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Sent | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
封筒の状態
|
DocuSignEnvelopeInformation.EnvelopeStatus.Status | string | |
|
サブジェクト
|
DocuSignEnvelopeInformation.EnvelopeStatus.Subject | string | |
|
送信者の名前
|
DocuSignEnvelopeInformation.EnvelopeStatus.UserName | string | |
|
RecipientStatus
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus | array of object | |
|
タブ
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.tabs | object |
この受信者のタブを表すキーと値のペア (ここで、キーはフィールド名、値はフィールド値)。 |
|
辞退理由
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.DeclineReason | DeclineReasonWithoutType | |
|
受信者の電子メール
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Email | string | |
|
受信者 ID
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RecipientId | string | |
|
ルーティング順序
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RoutingOrder | string | |
|
Recipient Sent Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Sent | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
受信者の状態
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Status | string |
受信者の状態。 |
|
受信者の種類
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Type | string |
受信者の種類。 |
|
受信者名
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.UserName | string |
受信者の名前。 |
|
タイム ゾーン
|
DocuSignEnvelopeInformation.TimeZone | string | |
|
タイム ゾーン オフセット
|
DocuSignEnvelopeInformation.TimeZoneOffset | string |
GetDocumentsResponse
- ファイル コンテンツ
- binary
AddRemindersResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アラームが有効
|
reminderEnabled | string |
アラームが有効 |
FilteredEnvelopes
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Title
|
title | string |
封筒のタイトル |
|
Description
|
description | string |
封筒アクティビティの説明 |
|
封筒 ID
|
envelopeId | string |
封筒 ID |
|
ドキュメント
|
documents | string |
ドキュメント名の一覧 |
|
受信者名
|
recipients | string |
受信者名の一覧 |
|
送信者名
|
sender | string |
送信者名 |
|
ステータス
|
status | string |
封筒の状態 |
|
状態の日付
|
statusDate | string |
アクティビティの最後の状態の更新 |
|
送信日
|
dateSent | date-time |
封筒の送信日 |
|
URL
|
url | string |
封筒の URL |
SalesCopilotFilteredEnvelopes
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Title
|
title | string |
封筒のタイトル |
|
字幕
|
subTitle | string |
封筒のサブタイトル |
|
URL
|
url | string |
封筒の URL |
|
その他のプロパティ
|
additionalPropertiesForSalesEnvelope.additionalPropertiesForSalesEnvelope | string |
その他のプロパティ |
Activity
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Title
|
title | string |
この出力は、引用カード内のアクティビティのタイトルを示します。 |
|
Description
|
description | string |
この出力は、分析情報の説明を示します。 |
|
DateTime
|
dateTime | date-time |
この出力は、分析情報に関連付けられている時間を示します。 |
|
URL
|
url | string |
この出力は、分析情報を開くための URL を示します。 |
|
その他のプロパティ
|
additionalProperties.additionalProperties | string |
アクティビティの追加プロパティ |
EmailSummary
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Title
|
Title | string |
この出力は、パートナー セクションのタイトルを示し、パートナーの名前のみを含める必要があります。 |
|
説明
|
Description | string |
この出力は、メールの概要に含めるテキストを示します。 |
KeySales
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Title
|
Title | string |
この出力は、分析情報の引用カードのタイトルを示します。 |
|
説明
|
description | string |
この出力は、主要な売上情報に含める分析情報のテキストを示します。 |
|
封筒の URL
|
url | string |
この出力は、分析情報の詳細を確認するための URL を示します。 |
|
分析情報に関連付けられている時間
|
dateTime | string |
この出力は、分析情報に関連付けられている時間を示します。 |
|
その他のプロパティ
|
additionalProperties.additionalProperties | string |
この出力は、アクションによって返される各関連分析情報の名前と値のペアとして追加のプロパティを示します。 |
DocumentRecord
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
レコード ID
|
recordId | string |
この出力は、アクションによって返される各関連レコードを一意に識別します。 |
|
レコードの種類の表示名
|
recordTypeDisplayName | string |
この出力は、アクションによって返される各関連レコードのレコードの種類の表示名を示します。 |
|
レコードの種類の表示名 (複数形)
|
recordTypePluralDisplayName | string |
この出力は、アクションによって返される各関連レコードのレコードの種類の複数形の表示名を示します。 |
|
レコード タイプ
|
recordType | string |
この出力は、アクションによって返される各関連レコードの種類を示します。 |
|
レコードのタイトル
|
recordTitle | string |
この出力は、アクションによって返される各関連レコードのタイトルを示します。 |
|
封筒の URL
|
url | string |
この出力は、アクションによって返される各関連レコードの URL を示します。 |
|
その他のプロパティ
|
additionalProperties.additionalProperties | string |
この出力は、アクションによって返される各関連レコードの名前と値のペアとして追加のプロパティを示します。 |
EmbeddedSenderResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
埋め込み送信者 URL
|
url | string |
埋め込み送信者ビューの URL。 |
EmbeddedSigningResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
URL
|
url | string |
埋め込み署名ビューの URL。 |
FilteredEnvelopeListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
フィルター処理された封筒
|
value | array of FilteredEnvelopes |
フィルター処理された封筒 |
|
その他のエンベロープの結果
|
hasMoreResults | boolean |
封筒が指定した数を超えたかどうかを [封筒の返送] フィールドに表示します |
FilteredSalesCopilotEnvelopeListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
フィルター処理された封筒
|
value | array of SalesCopilotFilteredEnvelopes |
フィルター処理された封筒 |
|
さらに結果があります
|
hasMoreResults | boolean |
ActivityListResponseEnvelope
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
関連アクティビティ
|
value | array of Activity |
関連するアクティビティ |
|
さらに結果があります
|
hasMoreResults | boolean |
EmailSummaryResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メールの要約
|
value | array of EmailSummary |
主要売上 |
|
さらに結果があります
|
hasMoreResults | boolean |
KeySalesResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
キーセールス'
|
value | array of KeySales |
主要売上 |
|
さらに結果があります
|
hasMoreResults | boolean |
DocumentRecordListResponseEnvelope
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
関連レコード
|
value | array of DocumentRecord |
関連レコード |
|
さらに結果があります
|
hasMoreResults | boolean |
CreateEnvelopeResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
封筒 ID
|
envelopeId | string |
封筒の ID。 |
|
テンプレート ID
|
templateId | string |
テンプレートの ID。 |
|
ステータス
|
status | string |
封筒の状態。 |
|
状態の日付時刻
|
statusDateTime | string |
状態が設定された日時。 |
|
URI
|
uri | string |
DocuSign 内のエンベロープの URI。 |
ListRecipientsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
署名
|
signers | array of Signer |
署名 |
タブ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タブ名
|
name | string |
タブの名前。 |
|
タブの種類
|
tabType | string |
タブの種類。 |
|
タブ ラベル
|
tabLabel | string |
タブのラベル。 |
|
タブ値
|
value | string |
タブの値。 |
|
タブ ID
|
tabId | string |
タブの ID。 |
|
ドキュメント ID
|
documentId | string |
ドキュメントの ID。 |
|
受信者 ID
|
recipientId | string |
受信者の ID。 |
|
[事前入力]
|
prefill | boolean |
タブがプレフィルの種類であるかどうかを示します。 |
|
選択済み
|
selected | string |
タブがチェック ボックスの場合は、タブが選択されているかどうかを示します。 |
RecipientTabsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[受信者] タブ:
|
recipientTabs | array of Tab |
[受信者] タブ |
署名
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
署名順序
|
routingOrder | string |
ドキュメント内の受信者の署名順序。 |
|
Role
|
roleName | string |
署名者の役割。 |
|
受信者 ID
|
recipientId | string |
受信者の ID。 |
|
名前
|
name | string |
受信者の名前。 |
|
Email
|
string |
受信者の電子メール。 |
|
|
受信者の種類
|
recipientType | string |
受信者の種類。 |
|
検証の種類
|
verificationType | string |
検証の種類。 |
|
Recipient Guid
|
recipientIdGuid | string |
受信者 Guid。 |
GetLoginAccountsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ログイン アカウント
|
loginAccounts | array of LoginAccount |
ログイン アカウント |
LoginAccount
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
アカウントの名前。 |
|
アカウント ID guid
|
accountIdGuid | string |
アカウントの GUID。 |
ListTabsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タブ
|
tabs | array of Tab |
タブ |
ListEnvelopeDocumentFieldsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー設定フィールド
|
envelopeDocumentFields | array of EnvelopeDocumentField |
ドキュメントのユーザー設定フィールド |
DocGenFormFieldsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Docgen フィールド
|
docgenFields | array of DocGenFormField |
Docgen フィールド |
DocGenFormField
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント ID
|
documentId | string |
ドキュメント ID。 |
|
ラベル
|
label | string |
ラベル。 |
|
タイプ
|
type | string |
Type。 |
|
名前
|
name | string |
名前。 |
|
価値
|
value | string |
価値。 |
ListTemplatesResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
封筒テンプレート
|
envelopeTemplates | array of EnvelopeTemplate |
使用可能なエンベロープ テンプレート。 |
EnvelopeTemplate
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テンプレート ID
|
templateId | string |
テンプレートの ID。 |
|
名前
|
name | string |
テンプレートの名前。 |
BulkSendListGuid
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
一括送信リストの GUID
|
listId | string |
一括送信リストの GUID |
EnvelopeCustomFieldResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
フィールド ID
|
fieldId | string |
封筒のユーザー設定フィールドの ID。 |
|
フィールドの型
|
fieldType | string |
封筒のユーザー設定フィールドの種類。 |
|
名前
|
name | string |
封筒のユーザー設定フィールドの名前。 |
|
価値
|
value | string |
封筒のユーザー設定フィールドの値。 |
UpdateEnvelopeCustomFieldResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
フィールド ID
|
fieldId | string |
封筒のユーザー設定フィールドの ID。 |
|
フィールドの型
|
fieldType | string |
封筒のユーザー設定フィールドの種類。 |
|
名前
|
name | string |
封筒のユーザー設定フィールドの名前。 |
|
価値
|
value | string |
封筒のユーザー設定フィールドの値。 |
ListDocumentsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
封筒ドキュメント
|
envelopeDocuments | array of EnvelopeDocument |
封筒に添付されているドキュメント。 |
ListTemplateDocumentsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テンプレート ドキュメント
|
templateDocuments | array of EnvelopeDocument |
テンプレートに添付されたドキュメント。 |
AddDocumentsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
封筒 ID
|
envelopeId | string |
封筒の ID。 |
|
封筒ドキュメント
|
envelopeDocuments | array of EnvelopeDocument |
封筒に添付されているドキュメント。 |
AddRecipientTabsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
受信者タブ
|
recipientTabs | array of RecipientTab |
受信者に追加されたタブ。 |
EnvelopeDocument
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
ドキュメントの名前。 |
|
ドキュメント ID
|
documentId | string |
ドキュメントの ID。 |
|
ドキュメント GUID
|
documentIdGuid | string |
ドキュメントの guid。 |
RecipientTab
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タブ ID
|
tabId | string |
タブの ID。 |
|
タブの種類
|
tabType | string |
タブの種類。 |
EnvelopeDocumentField
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
ユーザー設定フィールドの名前。 |
|
価値
|
value | string |
ユーザー設定フィールドの値。 |
DeclineReasonWithoutType
オブジェクト
これは型 'object' です。