DocuSign.Api.EnvelopeRecipients.recipients_put_recipients

You're seeing just the function recipients_put_recipients, go back to DocuSign.Api.EnvelopeRecipients module for more information.
Link to this function

recipients_put_recipients(connection, account_id, envelope_id, opts \\ [])

View Source

Specs

recipients_put_recipients(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.RecipientsUpdateSummary.t()} | {:error, Tesla.Env.t()}

Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST).

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :offline_signing (String.t):
    • :resend_envelope (String.t): When set to true, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.
    • :envelope_recipients (EnvelopeRecipients):

Returns

} on success {:error, info} on failure