DocuSign
DocuSign は、組織が契約を準備、署名、遂行、管理する方法を接続および自動化するのに役立ちます。
このコネクタは、次の製品および地域で利用可能です:
| サービス | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure China の地域 - 米国国防総省 (DoD) |
| Power Automate | Premium | 以下を除くすべての Power Automate 地域 : - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| Power Apps | Premium | 以下を除くすべての Power Apps 地域 : - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| 取引先担当者 | |
|---|---|
| 件名 | docusign |
| URL | https://support.docusign.com |
| コネクタ メタデータ | |
|---|---|
| 発行者 | DocuSign, Inc. |
| Web サイト | https://www.docusign.com |
| プライバシー ポリシー | https://www.docusign.com/company/privacy-policy |
| カテゴリー | コンテンツとファイル;生産性 |
注意
このコネクタは、 Power Automate ワークフローを構築および実行する際に、Microsoftから追加料金なしで使用できます。 プログラムの詳細については、 従量制の Power Automate embed をご覧ください。
この統合で Connect トリガーを使用するには、DocuSign Connect を DocuSign アカウントで有効する必要があります。 既定では有効になっていません。 有効にすると、DocuSign 管理 Web アプリケーションから「接続設定」ページにアクセスできます。 この統合で Connect トリガーを使用すると、Webhook が自動的に登録されます。
コネクタを試すには、DEMO アカウントを使用してください :
- https://developers.docusign.com/ に移動
- サンドボックス アカウントを作成します。
これらは無料試用版とは異なり、有効期限がなく、有料アカウント機能の 90% を使用することができ、DEMO を介して送信されるドキュメントはいずれも法的拘束力がありません ((https://support.docusign.com/en/articles/Free-account-vs-Developer-account)。
DocuSign の問題に関しては、最初にこのリンクを試してください: https://support.docusign.com/en/articles/How-Do-I-Open-a-Case-in-the-DocuSign-Support-Center。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 250 | 60 秒 |
アクション
| Sales Copilot: 関連するレコードを取得する |
Sales Copilot: 関連するレコードを取得します。 |
| Sales Copilot: 関連活動を取得する |
Sales Copilot: 関連活動を取得します。 |
| エンベロープ カスタム フィールドを更新する |
指定されたエンベロープ カスタム フィールドの値を更新する |
| エンベロープから受信者を削除する |
エンベロープから受信者を削除する |
| エンベロープにアラームを追加する |
エンベロープにアラームを追加する |
| エンベロープに受信者を追加する (V2) |
受信者をエンベロープに追加します。 |
| エンベロープのドキュメントを一覧表示する |
エンベロープのドキュメントを一覧表示する |
| エンベロープのドキュメント生成フォーム フィールドを更新する |
エンベロープのドキュメント生成フォーム フィールドを更新する |
| エンベロープの事前入力タブを更新する |
事前入力タブの一覧の値を更新する |
| エンベロープの送信 |
既存のエンベロープを送信します。 |
| エンベロープを作成する |
空白のエンベロープを新しく作成します。 |
| カスタム フィールドの情報をエンベロープから取得する |
カスタム フィールドの情報をエンベロープから取得する |
| テンプレートのドキュメントを一覧表示する |
テンプレートのドキュメントを一覧表示する |
| テンプレートの一覧を表示します |
指定したアカウントのテンプレート一覧を表示します。 |
| テンプレートの受信者を一覧表示する |
テンプレートの受信者を一覧表示する |
| テンプレートを使用してエンベロープを作成する |
指定したテンプレートを使用して新しいエンベロープを作成します。 |
| ドキュメント カスタム フィールドをエンベロープから取得する |
ドキュメント カスタム フィールドをエンベロープから取得する |
| ドキュメント タブをエンベロープから取得する |
ドキュメント タブをエンベロープから取得する |
| ドキュメント タブをテンプレートから取得する |
ドキュメント タブをテンプレートから取得する |
| ドキュメントをエンベロープから取得する |
ドキュメントをエンベロープから取得する |
| ドキュメントをエンベロープに追加する |
ドキュメントをエンベロープに追加します。 |
| ドキュメント情報をエンベロープから取得する |
ドキュメント情報をエンベロープから取得する |
| ドキュメント生成フォーム フィールドをエンベロープから取得する |
ドキュメント生成フォーム フィールドをエンベロープから取得する |
| ビルド番号を表示 (参照のみ。 実行フローに含めないでください) |
現在展開されているビルドの識別子です。 |
| ログイン |
ログイン |
| 受信者に検証の種類を追加する |
受信者に検証の種類を追加します。 |
| 受信者のタブの値をエンベロープで更新する |
受信者のタブの値をエンベロープで更新する |
| 受信者のタブをエンベロープに追加する |
受信者のタブをエンベロープに追加する |
| 受信者をエンベロープで更新する |
受信者をエンベロープで更新する |
| 受信者を含むテンプレートを使用してエンベロープを作成する |
指定されたテンプレートを使用して新しいエンベロープを作成し、受信者を指定します。 |
| 受信者タブの情報を取得する |
指定された受信者のタブの値を返します |
| 受信者タブをエンベロープから取得する |
受信者タブをエンベロープから取得する |
| 受信者情報をエンベロープから取得する |
受信者情報をエンベロープから取得する |
| 埋め込み署名 URL を生成する |
埋め込み署名 URL を生成する |
| 埋め込み送信者 URL を生成する |
埋め込み送信者 URL を生成する |
| 非推奨: エンベロープに受信者を追加する |
受信者をエンベロープに追加します。 |
| 非推奨: テンプレートを使用してエンベロープを作成する |
指定したテンプレートを使用して新しいエンベロープを作成します。 |
| 非推奨: ドキュメントをエンベロープから取得する |
ドキュメントをエンベロープから取得する |
Sales Copilot: 関連するレコードを取得する
Sales Copilot: 関連するレコードを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコードの種類
|
recordType | True | string |
レコードの種類の選択 |
|
レコード ID
|
recordId | True | string |
レコード ID |
|
開始日
|
startDateTime | date-time |
開始日時を次の形式で入力してください: 2017-05-02T01:44Z |
|
|
上
|
top | integer |
戻される上位のエンベロープ |
|
|
Skip
|
skip | integer |
スキップされるエンベロープ |
|
|
CRM の種類
|
crmType | string |
CRM の種類 |
|
|
CRM 組織 URL
|
crmOrgUrl | string |
CRM 組織 URL |
戻り値
Sales Copilot: 関連活動を取得する
Sales Copilot: 関連活動を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコードの種類
|
recordType | True | string |
レコードの種類の選択 |
|
レコード ID
|
recordId | True | string |
レコード ID |
|
開始日
|
startDateTime | date-time |
開始日時を次の形式で入力してください: 2017-05-02T01:44Z |
|
|
終了日
|
endDateTime | date-time |
終了日時を次の形式で入力してください: 2017-05-02T01:44Z |
|
|
上
|
top | integer |
戻される上位のエンベロープ |
|
|
Skip
|
skip | integer |
スキップされるエンベロープ |
|
|
CRM の種類
|
crmType | string |
CRM の種類 |
|
|
CRM 組織 URL
|
crmOrgUrl | string |
CRM 組織 URL |
戻り値
エンベロープ カスタム フィールドを更新する
指定されたエンベロープ カスタム フィールドの値を更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
Field ID
|
fieldId | True | string |
カスタム フィールド ID |
|
Field Type
|
fieldType | True | string |
カスタム フィールドの種類 |
|
件名
|
name | True | string |
カスタム フィールド名 |
|
価値
|
value | True | string |
カスタム フィールド値 |
戻り値
エンベロープから受信者を削除する
エンベロープから受信者を削除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アカウント
|
accountId | True | string |
取引先企業 ID |
|
フォルダー
|
folderId | True | string |
フォルダー ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
Recipient
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
受信者 ID |
戻り値
エンベロープにアラームを追加する
エンベロープにアラームを追加する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
アラームが有効
|
reminderEnabled | True | boolean |
false に設定すると、リマインダーは無効になります。 既定値は False です |
|
アラームの遅延
|
reminderDelay | True | string |
受信者がアラームのメールを受け取る日数を追加します。 |
|
アラームの頻度
|
reminderFrequency | True | string |
アラームのメールの間隔を日数で追加します。 |
戻り値
- Body
- AddRemindersResponse
エンベロープに受信者を追加する (V2)
受信者をエンベロープに追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
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
|
note | string |
受信者のカスタム メモです。 |
|
|
ロール名
|
roleName | string |
受信者に関連付けられたロール名です。 |
|
|
SMS 国コード
|
countryCode | integer |
SMS 通知の国コードでは、先頭の「 + 」記号を省略します。 |
|
|
SMS 電話番号
|
phoneNumber | integer |
SMS 通知の電話番号では国コードを省略します。 |
|
|
署名の種類
|
signatureType | string |
DocuSign 標準ベースの署名 (SBS) タイプ。 |
|
|
選択した受信者の種類の詳細
|
additionalRecipientParams | dynamic |
選択した受信者の種類の詳細です。 |
戻り値
- Body
- Signer
エンベロープのドキュメントを一覧表示する
エンベロープのドキュメントを一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
戻り値
エンベロープのドキュメント生成フォーム フィールドを更新する
エンベロープのドキュメント生成フォーム フィールドを更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
ドキュメントの GUID
|
documentGuid | True | string |
ドキュメントの GUID |
|
件名
|
name | string |
件名 |
|
|
価値
|
value | string |
価値 |
エンベロープの事前入力タブを更新する
事前入力タブの一覧の値を更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
ドキュメント ID
|
documentId | True | string |
ドキュメント ID |
|
タイプ
|
tabType | string |
タイプ |
|
|
Id
|
tabId | string |
Id |
|
|
価値
|
value | string |
価値 |
エンベロープの送信
既存のエンベロープを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
戻り値
- 返答
- object
エンベロープを作成する
空白のエンベロープを新しく作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
メール件名
|
emailSubject | True | string |
メールの件名。 |
|
電子メールの本文
|
emailBody | string |
メールの本文。 |
|
|
Custom Fields
|
accountCustomFields | dynamic |
取引先企業レベルで設定されたカスタム フィールドを取得します。 |
戻り値
カスタム フィールドの情報をエンベロープから取得する
カスタム フィールドの情報をエンベロープから取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
カスタム フィールド名
|
fieldName | True | string |
カスタム フィールド名 |
戻り値
テンプレートのドキュメントを一覧表示する
テンプレートのドキュメントを一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Template
|
templateId | True | string |
テンプレート ID |
戻り値
テンプレートの一覧を表示します
指定したアカウントのテンプレート一覧を表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
戻り値
テンプレートの受信者を一覧表示する
テンプレートの受信者を一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Folder
|
folderId | True | string |
フォルダー ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
戻り値
テンプレートを使用してエンベロープを作成する
指定したテンプレートを使用して新しいエンベロープを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Template
|
templateId | True | string |
テンプレート ID |
|
エンベロープの状態
|
status | True | string |
エンベロープの状態 |
戻り値
ドキュメント カスタム フィールドをエンベロープから取得する
ドキュメント カスタム フィールドをエンベロープから取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
ドキュメント ID
|
documentId | True | string |
ドキュメント ID |
戻り値
ドキュメント タブをエンベロープから取得する
ドキュメント タブをエンベロープから取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
ドキュメント ID
|
documentId | True | string |
ドキュメント ID |
戻り値
- Body
- ListTabsResponse
ドキュメント タブをテンプレートから取得する
ドキュメント タブをテンプレートから取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Template
|
templateId | True | string |
テンプレート ID |
|
ドキュメント ID
|
documentId | True | string |
ドキュメント ID |
戻り値
- Body
- ListTabsResponse
ドキュメントをエンベロープから取得する
ドキュメントをエンベロープから取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
出力書式
|
documentId | True | string |
ドキュメント ID を指定するか、ドロップダウンに表示される出力形式を使用します |
戻り値
ドキュメントをエンベロープに追加する
ドキュメントをエンベロープに追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
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 |
False |
|
|
受信者にタブを割り当てる
|
assignTabsToRecipientId | string |
受信者の ID |
戻り値
- Body
- AddDocumentsResponse
ドキュメント情報をエンベロープから取得する
ドキュメント情報をエンベロープから取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
Document name
|
documentName | True | string |
ファイル名 (拡張子あり) |
戻り値
- Body
- EnvelopeDocument
ドキュメント生成フォーム フィールドをエンベロープから取得する
ドキュメント生成フォーム フィールドをエンベロープから取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
戻り値
ビルド番号を表示 (参照のみ。 実行フローに含めないでください)
ログイン
受信者に検証の種類を追加する
受信者に検証の種類を追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
受信者 ID
|
recipientId | True | string |
受信者 ID |
|
受信者の種類
|
recipientType | True | string |
受信者の種類 |
|
検証の種類
|
verificationType | True | string |
検証の種類 |
|
追加の受信者データ
|
additionalRecipientData | dynamic |
追加の受信者データです。 |
戻り値
受信者のタブの値をエンベロープで更新する
受信者のタブの値をエンベロープで更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
Recipient
|
recipientId | True | string |
受信者 ID |
|
タイプ
|
tabType | string |
タブの種類 |
|
|
Id
|
tabId | string |
Id |
|
|
価値
|
value | string |
価値 |
受信者のタブをエンベロープに追加する
受信者のタブをエンベロープに追加する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
Recipient
|
recipientId | True | string |
受信者 ID |
|
タブの種類
|
tabType | True | string |
タブの種類 |
|
タブの詳細
|
tabDetails | True | dynamic |
選択したアンカー タブの詳細。 |
戻り値
受信者をエンベロープで更新する
受信者をエンベロープで更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
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
|
note | string |
受信者のカスタム メモです。 |
|
|
ロール名
|
roleName | string |
受信者に関連付けられたロール名です。 |
|
|
SMS 国コード
|
countryCode | integer |
SMS 通知の国コードでは、先頭の「 + 」記号を省略します。 |
|
|
SMS 電話番号
|
phoneNumber | integer |
SMS 通知の電話番号では国コードを省略します。 |
|
|
選択した受信者の種類の詳細
|
additionalRecipientParams | dynamic |
選択した受信者の種類の詳細です。 |
戻り値
- Body
- Signer
受信者を含むテンプレートを使用してエンベロープを作成する
指定されたテンプレートを使用して新しいエンベロープを作成し、受信者を指定します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Template
|
templateId | True | string |
テンプレート ID |
|
エンベロープの状態
|
status | True | string |
エンベロープの状態 |
|
署名者
|
signers | dynamic |
ドキュメントの署名者。 |
|
|
メール件名
|
emailSubject | string |
メール件名 |
|
|
電子メールの本文
|
emailBody | string |
電子メールの本文 |
戻り値
受信者タブの情報を取得する
指定された受信者のタブの値を返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
受信者 ID
|
recipientId | True | string |
受信者 ID |
|
タブ ラベル
|
tabLabel | True | string |
タブ ラベル |
戻り値
- Body
- Tab
受信者タブをエンベロープから取得する
受信者タブをエンベロープから取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
受信者 ID
|
recipientId | True | string |
受信者 ID |
戻り値
受信者情報をエンベロープから取得する
受信者情報をエンベロープから取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
受信者のメール
|
recipientEmail | string |
Recipient email |
|
|
Area Code
|
areaCode | string |
受信者の市外局番 |
|
|
Phone Number
|
phoneNumber | string |
受信者の電話番号 |
戻り値
- Body
- Signer
埋め込み署名 URL を生成する
埋め込み署名 URL を生成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
署名者の名前
|
signerName | True | string |
署名者の名前 |
|
署名者の電子メール
|
signerEmail | True | string |
署名者のメール アドレス |
|
クライアント ユーザー ID
|
clientUserId | True | string |
クライアント ユーザー ID |
|
認証方法
|
authenticationMethod | True | string |
認証方法 |
|
戻り先 URL
|
returnUrl | True | string |
戻り先 URL |
|
追加の追加先 URL
|
additionalURL | dynamic |
追加の追加先 URL です。 |
戻り値
埋め込み送信者 URL を生成する
埋め込み送信者 URL を生成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
で開く
|
openIn | True | string |
で開く |
|
戻り先 URL
|
returnUrl | True | string |
戻り先 URL |
|
追加の追加先 URL
|
additionalURL | dynamic |
追加の追加先 URL です。 |
戻り値
非推奨: エンベロープに受信者を追加する
受信者をエンベロープに追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
署名者の名前
|
AddRecipientToEnvelopeName | True | string |
受信者の名前。 |
|
署名者の電子メール
|
AddRecipientToEnvelopeEmail | True | string |
受信者の電子メール。 |
|
署名の順序
|
routingOrder | string |
ドキュメントが含む受信者の署名順序。 |
|
|
役割
|
roleName | string |
署名者のロール。 |
戻り値
非推奨: テンプレートを使用してエンベロープを作成する
指定したテンプレートを使用して新しいエンベロープを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Template
|
templateId | True | string |
テンプレート ID |
|
エンベロープの状態
|
status | True | string |
エンベロープの状態 |
|
Custom Fields
|
accountCustomFields | True | dynamic |
取引先企業レベルで設定されたカスタム フィールドを取得します。 |
戻り値
非推奨: ドキュメントをエンベロープから取得する
ドキュメントをエンベロープから取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
Envelope
|
envelopeId | True | string |
エンベロープ ID |
|
完了証明書
|
certificate | True | boolean |
False に設定するとエンベロープの署名済証明書をダウンロードから削除します。 |
戻り値
トリガー
| エンベロープの状態が変更されたとき (接続) (V3) |
エンベロープの状態が変更されると新しいフローをトリガーします。 |
| 非推奨: エンベロープの状態が変更されたとき (Connect) (V2) |
エンベロープの状態が変更されると新しいフローをトリガーします。 |
| 非推奨: エンベロープの状態が変更されたとき (接続) |
エンベロープの状態が変更されると新しいフローをトリガーします。 |
エンベロープの状態が変更されたとき (接続) (V3)
エンベロープの状態が変更されると新しいフローをトリガーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
接続名
|
name | True | string | |
|
エンベロープ イベント
|
envelopeEvents | True | string |
戻り値
非推奨: エンベロープの状態が変更されたとき (Connect) (V2)
エンベロープの状態が変更されると新しいフローをトリガーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
接続名
|
name | True | string | |
|
エンベロープ イベント
|
envelopeEvents | True | string |
戻り値
非推奨: エンベロープの状態が変更されたとき (接続)
エンベロープの状態が変更されると新しいフローをトリガーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
勘定科目
|
accountId | True | string |
取引先企業 ID |
|
接続名
|
name | True | string | |
|
エンベロープ イベント
|
envelopeEvents | True | string |
戻り値
定義
WebhookEnvelopeResponseV2
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Custom Fields
|
data.envelopeSummary.customFields | object |
このエンベロープのカスタム フィールドを表すキーと値のペア (キー: フィールド名、値: フィールド値)。 |
|
エンベロープを作成した日時
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
エンベロープ ID
|
data.envelopeSummary.envelopeId | string | |
|
エンベロープの送信日時
|
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 | |
|
受信者の送信日時
|
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
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Custom Fields
|
customFields | object |
このエンベロープのカスタム フィールドを表すキーと値のペア (キー: フィールド名、値: フィールド値)。 |
|
エンベロープを作成した日時
|
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 | |
|
エンベロープの送信日時
|
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 | |
|
受信者の送信日時
|
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 |
アラームが有効 |
活動
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
肩書き
|
title | string |
修復のタイトル |
|
プロパティ
|
description | string |
活動の説明 |
|
DateTime
|
dateTime | date-time |
活動の最後の状態更新 |
|
[URL]
|
url | string |
エンベロープの URL |
|
追加のプロパティ
|
additionalProperties.additionalProperties | string |
活動の追加のプロパティ |
DocumentRecord
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
レコード ID
|
recordId | string |
レコード ID |
|
レコードの種類の表示名
|
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 です。 |
ActivityListResponseEnvelope
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
関連する活動
|
value | array of Activity |
関連する活動 |
|
hasMoreResults
|
hasMoreResults | boolean |
DocumentRecordListResponseEnvelope
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
関連するレコード
|
value | array of DocumentRecord |
関連するレコード |
|
hasMoreResults
|
hasMoreResults | boolean |
CreateEnvelopeResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エンベロープ Id
|
envelopeId | string |
エンベロープの ID。 |
|
Template Id
|
templateId | string |
テンプレートの ID。 |
|
Status
|
status | string |
エンベロープの状態。 |
|
状況の日時
|
statusDateTime | string |
状態を設定済みの日時。 |
|
URI
|
uri | string |
DocuSign にあるエンベロープの URI。 |
ListRecipientsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
署名者
|
signers | array of Signer |
署名者 |
Tab キー
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タブ名
|
name | string |
タブの名前です。 |
|
タブの種類
|
tabType | string |
タブの種類。 |
|
タブ ラベル
|
tabLabel | string |
タブのラベルです。 |
|
タブ値
|
value | string |
タブの値です。 |
|
タブ ID
|
tabId | string |
タブの ID。 |
|
Document Id
|
documentId | string |
ドキュメントの ID。 |
|
受信者の ID
|
recipientId | string |
受信者の ID です。 |
|
事前入力
|
prefill | boolean |
タブ種類が事前入力かどうかを示します。 |
RecipientTabsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
受信者タブ:
|
recipientTabs | array of Tab |
受信者タブ |
Signer
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
署名順序
|
routingOrder | string |
ドキュメントが含む受信者の署名順序。 |
|
役割
|
roleName | string |
署名者のロール。 |
|
受信者 ID
|
recipientId | string |
受信者の ID。 |
|
件名
|
name | string |
受信者の名前。 |
|
メール
|
string |
受信者の電子メール。 |
|
|
受信者の種類
|
recipientType | string |
受信者の種類です。 |
|
検証の種類
|
verificationType | string |
検証の種類です。 |
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
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Document Id
|
documentId | string |
ドキュメント ID です。 |
|
Label
|
label | string |
ラベル。 |
|
タイプ
|
type | string |
タイプ。 |
|
件名
|
name | string |
名前。 |
|
価値
|
value | string |
値。 |
ListTemplatesResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エンベロープ テンプレート
|
envelopeTemplates | array of EnvelopeTemplate |
使用可能なエンベロープ テンプレートです。 |
EnvelopeTemplate
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Template Id
|
templateId | string |
テンプレートの ID。 |
|
件名
|
name | string |
テンプレートの名前。 |
EnvelopeCustomFieldResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Field ID
|
fieldId | string |
エンベロープのカスタム フィールドの ID です。 |
|
Field Type
|
fieldType | string |
エンベロープ カスタム フィールドの種類です。 |
|
件名
|
name | string |
エンベロープのカスタム フィールドの名前です。 |
|
価値
|
value | string |
エンベロープ カスタム フィールドの値です。 |
UpdateEnvelopeCustomFieldResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Field ID
|
fieldId | string |
エンベロープのカスタム フィールドの ID です。 |
|
Field Type
|
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 |
ドキュメントの名前。 |
|
Document Id
|
documentId | string |
ドキュメントの ID。 |
|
ドキュメントの GUID
|
documentIdGuid | string |
ドキュメントの GUID です。 |
RecipientTab
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タブ ID
|
tabId | string |
タブの ID。 |
|
タブの種類
|
tabType | string |
タブの種類。 |
EnvelopeDocumentField
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
件名
|
name | string |
カスタム フィールドの名前。 |
|
価値
|
value | string |
カスタム フィールドの値。 |
DeclineReasonWithoutType
オブジェクト
’オブジェクト’ という種類です。