Update a recipient for a document

This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.

patch/api/v1/documents/{id}/recipients/{recipientId}

Path parameters

idstring required

recipientIdstring required

authorizationstring required

namestring

emailstring email

role'CC' | 'SIGNER' | 'VIEWER' | 'APPROVER' | 'ASSISTANT'

signingOrdernumber nullable

200

idnumber required

documentIdnumber nullable

emailstring email required

namestring required

role'CC' | 'SIGNER' | 'VIEWER' | 'APPROVER' | 'ASSISTANT' required

signingOrdernumber nullable

tokenstring required

signedAtstring date-time nullable required

readStatus'NOT_OPENED' | 'OPENED' required

signingStatus'NOT_SIGNED' | 'SIGNED' | 'REJECTED' required

sendStatus'NOT_SENT' | 'SENT' required

signingUrlstring required

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