创建签名请求

在 Box 连接器中创建“签名请求”活动。

项目兼容性

Windows | 跨平台

概述

描述	API 方法	API 路径
使用 Box 签名模板为文档创建签名请求。	发布	/sign_requests/send

备注：

要使用“创建签名请求”活动创建签名请求，流程中使用的文档必须具有模板标签。

模板标签是您向 Box Sign 自动识别的基本文档添加数据的一种方式。要了解如何使用标签创建模板，请参阅官方Box 文档。

输入

参数	描述	数据类型
签名者的电子邮件	所有必需的签名者的电子邮件地址。可以指定签名者顺序，并将第一位签名者指定为索引 0。	字符串
要签名的文件	正在为其创建签名请求的文件。	数据列表
目标文件夹	完成后将签名的文档保存到的文件夹。	数据列表
模板	用于签名流程的 Box 签名模板。可以直接在 Box 中创建模板。	数据列表
电子邮件主题	发送给收件人的签名请求电子邮件的主题行。	字符串
电子邮件消息	发送给签名者的电子邮件中包含的消息正文。	字符串
提醒	如果启用，Box 将自动在第 3、8、13 和 18 天向未完成的签名者发送提醒。	boolean
天数有效	如果未完成签名请求，该签名请求将自动过期的天数。	Int32
是否启用了文本签名	确定是否允许签名者通过键入自己的姓名（文本签名）来进行签名。如果禁用，则仅允许提取签名或上传签名。	boolean
外部 ID	用于在外部系统中引用签名请求的标识符。	字符串
预填充标签文本值	用于预填充模板中定义的相应文本标签的文本值。	字符串
预填充标签日期值	用于预填充模板中定义的日期标签的日期值。	datetime
是否需要准备文档	指示在发送前是否需要准备文档（例如，设置字段）。	boolean
预填充“标签”复选框的值	用于在模板中预填充复选框字段的布尔值。	boolean
预填充标签文档标签 ID	预填充字段的标签 ID，如 Box 标志模板中所定义。	字符串

备注：

模板标签按照将电子邮件地址添加到“签名者电子邮件”字段的顺序分配。这与签名顺序不同。如果文档上的标签数量多于实际签名者的数量，则不会填充这些标签。如果您添加的签名者数量超过标签标签数量，则额外的签名者可以对文档进行签名，但不会被定向到文档中的这些位置。他们可以在文档中的任意位置添加文本、日期和签名。

输出

参数	描述	数据类型
签名请求 ID	新建签名请求的唯一标识符。	字符串
创建签名请求	详细说明已创建签名请求的完整响应对象。	object

备注：

• 在 API 工作流中，系统会返回一个响应对象作为输出。任何必填字段均可直接从此对象中提取。
• 在 RPA 工作流中，某些输出参数可能有所不同，但即使未显式公开，仍可以从响应对象中检索必要的值。