編輯簽署人

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"
      }
    ]
  }
}