Skip to main content

Update recipients

PUT 
/restapi/v2.1/accounts/:accountId/envelopes/:envelopeId/recipients

Update recipients that have not completed. A draft envelope accepts every mapped field (email, name, routingOrder, roleName, clientUserId, accessCode, recipient type); a sent envelope accepts a name and email correction, which re-notifies the recipient whose turn it is unless they are an embedded signer. The response is 200 with a recipientUpdateResults entry per recipient (errorDetails.errorCode is SUCCESS or the reason that recipient was not changed), as Docusign returns it.

Request​

Responses​

Recipients updated successfully

Response Headers
    X-Request-Id

    Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.

    traceparent

    W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.