Documents

Create a document reminder

Send a manual reminder to the recipients of a sealed document. type is required and selects how the reminder is sent:

  • email sends a reminder email. text and subject are optional, and recipient_ids, not_signed and not_opened select the recipients.
  • sms sends text as an SMS to the recipients in recipient_ids, or to the recipients that have not signed when it is omitted. Without text nothing is sent.
  • video sends the video in video_id, which is required. recipient_ids and the filters are ignored.

The response is { "status": 1 } when the reminder was accepted for sending and an empty array [] when nothing was sent. A document that is not sealed yet (status draft, importing, processing or scheduled) answers 400.

post/v1/documents/{documentId}/reminders

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/documents/{documentId}/reminders
  • Auth: HTTP bearer

Path parameters

documentIdstring required

Id of the document.

Request body

type'sms' | 'email' | 'video' required

Type of reminder to send. A missing or unknown type answers 400.

textstring nullable

Text of the reminder. Required for an sms reminder: when it is missing or empty nothing is sent and the response is an empty array. Optional for email and video reminders; in an email it can contain merge tags.

subjectstring nullable

Custom subject line for the reminder email. Only applies to email reminders; the default reminder subject is used when omitted.

recipient_idsstring[] nullable

Recipient ids to remind. For an email reminder combined with not_signed or not_opened, only the listed recipients that match the filter are reminded. For an sms reminder, the recipients that have not signed are reminded when it is omitted. Not used for video, but an invalid id still answers 400.

not_signedboolean

Email reminders only: remind the recipients that have not signed or approved the document. When both not_signed and not_opened are true, only not_opened applies. Without recipient_ids, set not_signed or not_opened, or no recipient is reminded.

not_openedboolean

Email reminders only: remind the recipients that have not opened the document. Takes precedence over not_signed when both are true.

video_idstring nullable

Id of an existing or uploaded video. Required for a video reminder, which answers 400 without it, and ignored for the other types.

Response

The reminder was accepted for sending, or an empty array when nothing was sent.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.