DOdocumenso
Document Recipients

Update document recipient

Changed on

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

  • Base URL
    https://app.documenso.com/api/v2
  • Auth
    API key in header Authorization

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

Changes

  • d1369b2bf296Revision changes
    • info

      added the optional property //// to the response with the status

  • 95f4d5924517Revision changes
    • breaking

      the / request property type changed from number to integer

    • warning

      the / request property's min was set to 0.00