Sign in

v2

OpenAPI 3.0.32026-07-31890635.1 KB
Document Recipients

Update document recipient

Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update a single recipient for a document.

post/document/recipient/update

Request body

documentIdnumber required

Response

Successful response

envelopeIdstring required
role'CC' | 'SIGNER' | 'VIEWER' | 'APPROVER' | 'ASSISTANT' required
readStatus'NOT_OPENED' | 'OPENED' required
signingStatus'NOT_SIGNED' | 'SIGNED' | 'REJECTED' required
sendStatus'NOT_SENT' | 'SENT' required
idnumber required
emailstring required
namestring required
tokenstring required
documentDeletedAtstring nullable required
expiredstring nullable required
expiresAtstring nullable required
expirationNotifiedAtstring nullable required
signedAtstring nullable required
signingOrdernumber nullable required
rejectionReasonstring nullable required
documentIdnumber nullable
templateIdnumber nullable