Setting up reminder email and its frequency using APEX SDK

Hi Anway, To set up a reminder, you'd invoke an extra Rest API/APEX fucntion, because the reminder related information is not included in the package JSON.

HTTP Request
POST /api/packages/{packageId}/reminders

HTTP Headers
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Request Payload

{
  "startInDaysDelay": 1,
  "repetitionsCount": 5,
  "intervalInDays": 1,
  "packageId": "{packageId}"
}

It's not an out-of-the box function provided by the APEX SDK, however, I've created the custom function in this code share. You'll also find the instructions from this guide. Duo

Anway, You may find the sample code complex, the main reason is the line 305:

		inboundReplacementMap.put('date','date_x');	//added line

Where I added an extra keyword escape for inbound payload, which only affects the GET function when you tried to grab the already-set reminders in a package and doesn't affect the POST(create) and PUT(update) functions. Duo

Thanks Duo for the details. Have one more question on this, if customer signs the document back before first reminder is sent out, do we have to explicitly call clearReminderScheduleForPackage process to clear the existing reminders or do they get cleared automatically? Thanks Anway Kabir

Hello Duo, do you have any update on this request?

Thanks!

Hi Anway,

 

Sorry for the late response, after migration, I stop receiving emails that reminds me of new replies.

 

For your question, the reminder email will only sent to recipients who hasn't completed signing, therefore you don't need to explicitly remove the schedules.

(Similarly, if you draft an ongoing package and resent again, signers who has completed signing won't receive the invitation email again.)

 

Duo