Skip to content

Recipients

Resend request

Resend the signing request email to a recipient who has not completed, as a reminder or after a soft bounce, within the documented wait periods.

POST
/ v1 / recipients / {recipient_id} / resend

Resends the signing request to a recipient who has not yet completed their ceremony.

Use this endpoint to:

  • Send reminders. If a recipient has not signed, resend the invitation as a reminder.
  • Retry after a soft bounce. If the invitation email was temporarily undeliverable, resend to try again.
  • Re-deliver a lost email. If a recipient reports not receiving the invitation, resend it.

The resend is rate-limited to prevent email spam. The response includes can_resend_at, which tells you when the next resend can be initiated. The wait period after each email depends on how many have been sent so far, counting the first invitation:

Emails sentWait before the next resend
1-315 minutes
4-61 hour
7-924 hours
10No more resends allowed

A request sent before can_resend_at fails with too-early-to-resend, and a request after the tenth email fails with too-many-attempts. For reminders, space them at least 24 hours apart, and read can_resend_at from each response.

The request can only be resent if the recipient’s ceremony uses email_link authentication, the recipient’s status is sent or soft_bounced, and the envelope status is in_progress.

Path Parameters

recipient_idstringrequired

The unique identifier of the recipient. Recipient IDs use the re_ prefix.

Returns

Returns a 200 OK status code along with the following property:

Time after which the next resend can be initiated, in format.

Errors

StatusTypeWhen
404not-foundNo recipient with this ID exists in the account and mode of your API key.
409too-early-to-resendThe time in can_resend_at has not passed yet. The detail names the time.
409too-many-attemptsTen emails have already been sent to this recipient.
409cannot-resendThe recipient has no active email_link ceremony, its status is not sent or soft_bounced, or the envelope is not in_progress.
422validation-errorThe request body is invalid.

For errors every endpoint can return, such as authentication and rate limits, see Errors.