v1
documents

Correct Document Recipient Email

Correct the email of an unsigned recipient on a live envelope.

Same recipient row and signing token as the original send. Does not void, so signatures already collected from other recipients stay valid. Sends a fresh invite when the envelope was sent with send_invite=true (the default). send_invite=false still updates the stored address — the integrator keeps delivering the existing signing link — and later reminders go to the new address.

post/api/v1/documents/{document_id}/recipients/{recipient_id}/email

Request

  • Base URL: https://zsign.io (the document declares no server; this is the origin it was published from)
  • URL: https://zsign.io/api/v1/documents/{document_id}/recipients/{recipient_id}/email
  • Auth: HTTP bearer

Path parameters

document_idstring uuid required
recipient_idstring uuid required

Request body

emailstring email required

Response

Successful Response

session_idstring uuid required
recipient_idstring uuid required
emailstring required
previous_emailstring required
invite_sentboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.