Sign in

v2

OpenAPI 3.0.32026-07-31890635.1 KB
Envelope Recipients

Reject envelope recipient on behalf of

Records a rejection on behalf of a recipient. Use this when a recipient has declined to sign outside of the platform. The rejection is flagged as external in the document audit log. By default the action is attributed to the API user; supply actAsEmail to attribute it to a specific team member.

post/envelope/recipient/{recipientId}/reject

Path parameters

recipientIdnumber required

The ID of the recipient to reject the document on behalf of.

Request body

envelopeIdstring required
reasonstring required
actAsEmailstring

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