署名リクエストを作成

プロジェクトの対応 OS

Windows | クロスプラットフォーム

概要

説明	API メソッド	API パス
Box Sign テンプレートを使用してドキュメントの署名リクエストを作成します。	POST	/sign_requests/send

注:

[署名リクエストを作成] アクティビティで署名リクエストを作成するには、プロセスで使用するドキュメントにテンプレート タグを付ける必要があります。

テンプレートタグは、Box Signによって自動的に認識されるベースドキュメントにデータを追加する方法です。タグを使用したテンプレートの作成方法については、 Box の公式ドキュメントをご覧ください。

入力

パラメーター	説明	データ型
署名者のメール アドレス	必要なすべての署名者のメール アドレス。署名者の順序は、最初の署名者をインデックス 0 として指定して指定できます。	string
署名するファイル	署名リクエストを作成するファイルです。	データリスト
移動先フォルダー	完了後に署名済みドキュメントが保存されるフォルダーです。	データリスト
テンプレート	署名プロセスに使用するBox Signテンプレートです。テンプレートはBox内で直接作成できます。	データリスト
メールの件名	受信者に送信される署名依頼メールの件名です。	string
メール メッセージ	署名者に送信されるメールに含まれるメッセージ本文です。	string
アラーム	有効にすると、Boxは3日目、8日目、13日目、18日目に未処理の署名者に自動的にリマインダーを送信します。	Boolean
有効日数	署名リクエストが完了していない場合、署名リクエストが自動的に期限切れになるまでの日数です。	int32
テキスト署名は有効ですか	署名者が名前を入力して署名できるかどうかを決定します(テキスト署名)。無効にすると、描画またはアップロードされた署名のみが許可されます。	Boolean
外部 ID	外部システムで署名リクエストを参照するために使用される識別子。	string
タグのテキスト値を事前入力する	テンプレートで定義された対応するテキスト タグを事前入力するためのテキスト値です。	string
タグ、日付、値を事前入力する	テンプレートで定義された日付タグの事前入力に使用する日付値です。	datetime
ドキュメントの準備は必要ですか	送信前にドキュメントの準備 (フィールドの設定など) が必要かどうかを示します。	Boolean
タグのチェックボックスの値を事前入力する	テンプレートのチェックボックス フィールドを事前入力するために使用される Boolean 値です。	Boolean
事前入力タグ ドキュメント タグ ID	Box Sign テンプレートで定義された、事前入力されるフィールドのタグ ID です。	string

注:

テンプレートタグは、電子メールアドレスが 「署名者の電子メール 」フィールドに追加された順序で割り当てられます。これは署名の順序と同じではありません。実際の署名者よりも多くのタグがドキュメントにある場合、それらのタグは入力されません。タグよりも多くの署名者を追加すると、追加の署名者は文書に署名できますが、文書内の場所には移動しません。テキスト、日付、署名を文書内の任意の場所に追加できます。

出力

パラメーター	説明	データ型
署名リクエスト ID	新しく作成される署名リクエストの一意の識別子です。	string
署名リクエストを作成	作成された署名要求の詳細を示す完全な応答オブジェクト。	object

注:

• API ワークフローでは、単一の応答オブジェクトが出力として返されます。必須フィールドは、このオブジェクトから直接抽出できます。
• RPA ワークフローでは、一部の出力パラメーターが異なる場合がありますが、明示的に公開されていない場合でも、必要な値を応答オブジェクトから取得できます。