编辑签署人

POST/esignglobal/v1/envelope/recipients/editSigners

接口说明

修改信封中未完成签署的签署人信息。

开发者在创建信封后，如果发现签署人联系方式、签署人姓名、通知配置或身份验证方式填写错误，或需要更换签署人信息，可以通过该接口更新未完成签署的签署人信息，避免因信息错误导致信封作废重发。

注意事项

仅支持修改未完成签署的签署人。
已签署、已拒签等终态签署人不支持修改。
信封处于终态或已作废状态时，不支持修改签署人信息。
当通知方式同时包含短信和邮件时，不支持仅修改 phoneNumber。
接口会比对传入的签署人信息和当前签署人信息；如信息不一致，则更新对应签署人信息。

请求参数

参数名称				类型	是否必填	说明
envelopeId				string	true	信封 ID
signerInfos				object	true	签署人信息
	recipientId			string	true	参与人ID
	businessId			string	false	开发者自定义业务编号，长度限制500
	deliveryMethods			string	false	通知方式，默认为auto auto-传入userEmail时发送邮件通知，传入phoneNumber时发送短信通知 none-不发送消息通知 email-发送邮件通知 sms-发送短信通知 WhatsApp-发送WhatsApp通知
	userEmail			string	false	签署人邮箱地址
	userName			string	true	签署人姓名，用于签署页面与信封对外展示签署人姓名。【注】不可含有以下9个特殊字符：/ \ : * " < > \| ？以及所有emoji表情
	minimumReadingDuration			int	false	设置页面强制阅读倒计时时间，默认值为 0（单位：秒，最大值999） 0 或不传表示不开启，无需阅读倒计时
	readToEndRequired			boolean	false	表示是否必须阅读到底。默认 false； true 表示开启，false 或不传表示不开启。
	phoneNumber			object	false	电话号码，默认为空当需要进行短信通知时为必填参数，countryCode与number都需要传入
		countryCode		string	false	国家地区的国际码，无需传入“+”
		number		string	false	无格式校验，仅限制长度最大为13位
	customizeSettings			object	false	自定义配置
		notificationSettings		object	false	通知类自定义配置
			customizeMessage	string	false	专属消息通知，字符限制200
			notificationLanguage	string	false	通知语言，默认取“默认通知语言”配置 en-US 英语 zh-CN 简体中文 zh-Hant 繁体中文 ja-JP 日语 es-MX 西班牙语 pt-PT 葡萄牙语 th-TH 泰语 id-ID 印尼语 vi-VN 越南语 ms-MY 马来语 fil-PH 菲律宾语 de-DE 德语 fr-FR 法语 ru-RU 俄语 it-IT 意大利语 ko-KR 韩语
	authModes			string	false	校验方式，默认为noAuth noAuth-不验证 accessCode-使用签署口令验证 sms-SMS OTP 验证 idVerification-身份证件验证 emailAuth-邮箱OTP验证 digitalId-电子身份验证 whatsappAuth-WhatsApp OTP验证
	authConfig			object	false	验证方式设置
		accessCode		object	false	签署口令设置，当authModes=accessCode时必填
			accessCode	string	false	口令内容，不区分大小写，可以包含字母数字，长度限制45
			promptInfo	string	false	访问口令提示信息，不可以包含访问口令，长度限制30，当authModes=1时必填。
		sms		object	false	SMS OTP校验，当authModes=sms时必填
			countryCode	string	false	国家地区的国际码，无需传入“+”
			number	string	false	不做格式校验，仅限制长度最大为13位
		idVerification		object	false	身份证件验证设置，当authModes=idVerification时必填
			name	string	false	签署人身份证件上的姓名全称，最大长度100个字符
		emailAuth		object	false	邮箱OTP校验，当authModes=emailAuth时必填
			authEmail	string	false	签署人身份验证邮箱地址
		digitalId		array	false	电子身份验证，当authModes=digitalId时必填
			authApp	string	false	电子身份验证使用的APP singpass-使用Singpass进行身份认证
			idNumber	string	false	签署人待验证的身份证件号码
		whatsappAuth		object	false	WhatsApp OTP验证，当authModes=whatsappAuth时必填
			countryCode	string	false	国家地区的国际码，无需传入“+”
			number	string	false	不做格式校验，仅限制长度最大为13位

响应示例

{
  "code": 0,
  "message": "success",
  "data": {
    "envelopeId": "9fbe6c8190824227bde29136b0145c81",
    "signerInfos": [
      {
        "recipientId": "recipient_123456789",
        "businessId": "biz-20260604-001",
        "userEmail": "new_signer@example.com",
        "userName": "Alex Chen"
      }
    ]
  }
}