v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeRecipients

Adds one or more recipients to an envelope.

Adds one or more recipients to an envelope.

For an in-process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional resend_envelope query string is set to true.

Note: This method works on recipients only. To add recipient tabs, use methods from the EnvelopeRecipientTabs resource. For example, this request body will add a recipient (astanton@example.com) but NOT the Sign Here recipient tab.

{
  "signers": [
    {
      "email": "astanton@example.com",
      "name": "Anne Stanton",
      "recipientId": "1",
      "tabs": {           // These tabs will NOT be added
        "signHereTabs": [ // with this method. See note above.
          {
            "anchorString": "below",
            "tooltip": "please sign here"
          },
          . . .
        ]
      }
    }
  ]
}

Related topics

  • How to bulk send envelopes
  • How to request a signature by email
  • How to request a signature through your app
post/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

envelopeIdstring required

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Query parameters

resend_envelopestring

When true, forces the envelope to be resent if it would not be resent otherwise.

Ordinarily, if the recipient's routing order is before or the same as the envelope's next recipient, the envelope is not resent.

Setting this query parameter to false has no effect and is the same as omitting it altogether.

Request body

currentRoutingOrderstring

The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.

recipientCountstring

The number of recipients in the envelope.

Response

Successful response.