如何通过DocuSign REST API更新信封收件人状态
如何通过DocuSign REST API更新信封收件人状态
没问题,我来一步步告诉你怎么用DocuSign的REST API把指定收件人的状态改成「Completed」~
首先,你需要用PUT请求调用收件人更新端点,具体的端点格式如下:
{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients
(把里面的{{baseUrl}}、{{apiVersion}}、{{accountId}}、{{envelopeId}}替换成你实际的参数就行)
必备请求头
请求里必须带上这两个关键请求头:
Authorization: Bearer {你的访问令牌}Content-Type: application/json
请求体示例
请求体需要明确指定你要更新的收件人,核心是正确的recipientId(就是你之前调用获取收件人API返回的那个ID),然后把status字段设为"completed"。给你一个完整的请求体例子:
{ "recipients": { "signers": [ { "recipientId": "1", "status": "completed" } ] } }
如果你的收件人是其他类型(比如审批人),就把signers换成对应的类型字段,比如approvers,但结构是一样的——只要对应上收件人类型,带上正确的recipientId和目标状态就行。
重要注意事项
- 权限要求:只有信封的创建者、账户管理员,或者拥有修改信封权限的用户,才能执行这个更新操作
- recipientId必须准确:这个ID是唯一标识收件人的关键,填错的话会更新到错误的收件人,一定要和你之前获取的收件人数据里的ID完全匹配
- 信封状态限制:如果信封已经处于终态(比如「Completed」「Voided」),是没法再修改收件人状态的,要确保当前信封状态允许进行这类更新
如果之后遇到报错,可以先检查这几个点,一般就能定位到问题啦~




