CODEWITHSUNDEEP
docusignapi
Josh
Josh

Reputation: 101

Set docusign envelope TTL?

How can I set the TTL on an envelope to be signed by Captive recipients?

I've googled docusign api ttl and searched StackOverflow. Surprisingly I see references that Docusign can say an envelope has expired, but I've not seen how to set the expiry time for an envelope.

In my testing, I generated a bunch of envelopes that I sent to myself, that I didn't sign. Docusign keeps sending reminders about them. Now it's been 2 days since the envelopes were generated. I don't want the clients receiving emails about it so long after they were supposed to sign.

My intention is they will be re-directed from my web-app to Docusign, they sign, then they come back to my app. If they don't sign by the end of the day (I'll set the TTL dynamically) then the envelope and it's URL must expire and they must not keep getting emails about it. If they want to sign after that, they must login to my web-app, then ask to sign again, and a new envelope will be generated for them, and they'll be redirected to it.

How can I set the TTL for the envelope?

EDIT:

I just found this: Embedded Signing api docusign

The unrelated, but relevant answer claims that captive recipient URLs have a TTL of 5 minutes. So a 5 min expiry for the envelope URL is fine, but I don't want the customer getting emails from docusign about it constantly for 2 days afterwards. I want the whole envelope/contract to expire within a short time. As above.

EDIT 2

I'm using the params mentioned by CodingDawg to good effect,

However my signer still gets emails from Docusign to say that they've viewed the envelope etc. It may be a little confusing to them.

I've moved this question to a separate SO question: Suppress emails to embedded signers (captive recipients) or at least add text to the unwanted emails?

Upvotes: 1

Views: 420

Answers (1)

Praveen Reddy
Praveen Reddy

Reputation: 7393

You can set the notification property in your Envelope:Create api call to set the TTL for an evelope.

Here is a sample Request. You can see the definition of the following properties here (After clicking the link expand the notification accordian)

"notification": {
   "expirations": {
     "expireAfter": 2,
     "expireEnabled": true,
     "expireWarn": 2
   },
   "reminders": {
     "reminderDelay": 2,
     "reminderEnabled": false,
     "reminderFrequency": 2
   },
 "useAccountDefaults": false
}

Upvotes: 0

Related Questions