署名リクエストを作成します。これには、署名用ドキュメントの準備と署名者への署名リクエストの送信が含まれます。
true
3、8、13、18日目にドキュメントに署名するよう署名者に促します。リマインダは未署名の署名者にのみ送信されます。
true
true
(テキストの) 入力で生成された署名の使用を 無効にします。
2
0
730
作成した署名リクエストが完了しなかった場合に自動的に期限切れになるまでの日数を設定します。デフォルトでは、署名リクエストに有効期限を適用しないため、署名リクエストは期限切れになりません。
"https://declined-redirect.com"
署名者がドキュメントへの署名を拒否した後にリダイレクトされるURI。
"Hello! Please sign the document below"
署名リクエストメールに含めるメッセージ。このフィールドは、特定の文字のサニタイズによって消去されます。ただし、一部のHTMLタグは使用できます。また、このメッセージに含まれているリンクはメールではハイパーリンクに変換されます。このメッセージには、HTMLタグa
、abbr
、acronym
、b
、blockquote
、code
、em
、i
、ul
、li
、ol
、strong
を含めることができます。HTMLに対するテキストの比率が大きすぎると、メールがスパムフィルタに入る可能性があることに注意してください。これらのタグにカスタムスタイルを適用することはできません。このフィールドを渡さない場合は、デフォルトのメッセージが使用されます。
"Sign Request from Acme"
署名リクエストメールの件名。これは、署名リクエストによって消去されます。このフィールドを渡さない場合は、デフォルトの件名が使用されます。
"123"
これは、署名リクエストが関連する外部システムのIDを参照する際に使用できます。
"Box"
署名ログで、embed_url_external_id
が割り当てられている署名者の横に表示するシステム名 (省略可) として使用されます。
true
UIを使用してドキュメントの準備を完了するために送信者がレスポンスでprepare_url
を受け取る必要があるかどうかを示します。
"name"
署名リクエストの名前。
最終的な署名済みドキュメントと署名ログの保存先フォルダ。ID
フィールドとtype
フィールドのみが必須です。ルートフォルダ (フォルダID 0
) は使用できず、nullにすることもできません。
署名リクエストの作成時にこの値が渡されない場合は、デフォルトのフォルダを使用することになります。デフォルトのフォルダは、ペイロードの最初のソースファイルの親フォルダ (そのフォルダへのアップロード権限がある場合) または「My Sign Requests」という名前のフォルダになります。
署名に関連するタグがドキュメントのコンテンツに含まれている場合、このprefill_tags
を使用してタグを事前入力できます。その際、タグの「id」を事前入力タグのexternal_id
フィールドとして参照します。
true
チェックボックスの事前入力値
"2021-04-26"
日付の事前入力値
"1234"
これは、署名リクエストのファイルに含まれている特定のタグのIDを参照します。
"text"
テキストの事前入力値
"https://www.example.com"
指定した場合、ドキュメントに署名された時点で、署名リクエストがこのURLにリダイレクトされます。
"blue"
署名に特定の色 (青、黒、または赤) を強制します。
次の値のいずれか1つ: blue
,black
,red
署名リクエストの署名者の配列。許可されている署名者の最大数は35です。
注: 一部の署名者が競合するセグメント (ユーザーグループ) に属している可能性もあります。これは、セキュリティポリシーにより、倫理的な競合につながる可能性のあるやり取りやコミュニケーションを防ぐためにユーザーがセグメントに割り当てられていることを意味します。このような場合、署名リクエストを送信しようとすると、エラーが発生します。