能否通过Docusign API在文档指定位置添加自定义字段?及API端点咨询
使用DocuSign API在指定位置添加自定义字段的方案
当然可以通过DocuSign API在文档指定位置添加自定义字段,具体实现和对应端点如下:
核心逻辑说明
DocuSign里的自定义字段对应标签(Tabs),你需要创建对应类型的标签(如文本框、复选框等),并指定其在文档中的精确位置,将这些标签关联到信封或收件人即可。
对应API端点
- 创建信封时同步添加:使用
POST /v2.1/accounts/{accountId}/envelopes端点,在请求体中直接嵌入标签配置。 - 未发送信封后续添加:如果信封尚未发送,可调用
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs端点,更新收件人的标签配置。
关键配置要点
- 精准定位:必须指定目标文档的
documentId、标签所在的pageNumber,以及xPosition(水平坐标)、yPosition(垂直坐标)来确定字段位置。 - 自定义属性:可配置
tabLabel(自定义字段的唯一标识)、value(默认填充值)、required(是否为必填项)等属性。 - 请求示例片段(创建信封时添加):
{ "emailSubject": "请签署指定文档", "documents": [ { "documentId": "1", "name": "合作协议.pdf" } ], "recipients": { "signers": [ { "email": "signer@example.com", "name": "张三", "recipientId": "1", "tabs": { "textTabs": [ { "tabLabel": "项目编号", "value": "PROJ-2024-005", "documentId": "1", "pageNumber": "1", "xPosition": "150", "yPosition": "300", "required": "true" } ] } } ] }, "status": "sent" }
内容的提问来源于stack exchange,提问作者VBK
相关产品推荐
相关产品推荐

