I have set up the branding options on dashboard/preferences.
The Sample email on dashboard looks as expected.
However when I send out the email for signing, triggered by an API call I get the default docusign email, and not the branded email that I have prepared.
Am I suppose to add something to the code to say use this brand for email?
Yes, you will want to include the BrandID in your envelope creation API call.
You can get the BrandID by editing your brand and then clicking on the Info tab.
https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm#REST%20API%20References/Send%20an%20Envelope.htm?Highlight=brandid
Another option: Under branding preferences, you can specify which brand should be used as your 'sign default', so in the event that a brandID is not provided, this specific brand will be used.
Related
We use the rest API (https://demo.docusign.net/restapi) for sending envelopes. When a signer declines the envelope, the sender receives an email containing a default subject ('Declined: '). We would like to change the email subject to a custom text (only when declined).
I found some directions on https://support.docusign.com/en/answers/00086200 which states we could change the EnvelopeDeclined_Subject in the EmailResource,
but we would prefer to provide the subject via the API instead.
Is this possible? And if so, how?
No, you cannot change Subject via API just for Decline email notification. If you want hard coded Decline Message for all your envelopes then you can modify Email Resource File. Since Decline is one of the terminal state and once envelope reaches a terminal state then you cannot modify anything on an envelope.
It's not possible to customize the Email Subject for DocuSign Completed/Voided/Declined emails at runtime on a per-envelope basis purely by using the API. However, you can achieve somewhat "runtime" control over email contents by using Branding and customizing the Email Resource File to specify the subject for the Decline Envelope Email. At a high-level, you'd do this by doing the following:
Use the DocuSign web UI to login as an Admin user and create a new Brand for the account.
Edit the Email Resource File that's associated with the brand to specify the custom subject for the envelope completion email.
When sending the Envelope via the API, specify brandId within the Create Envelope request to specify the id of the Brand you created in step 1 (and customized in step 2).
So, for example, let's say you had 5 different variations of email subject for Declined Envelopes -- and wanted to be able to specify (via the API) which one to use for each Envelope that you create/send via API. You'd create 5 separate Brands via the DocuSign web UI, customize the Email Resource File for each of those 5 brands (to specify the Email Subject to use for the Declined Envelope email), then when you create/send an Envelope with the API, set brandId to specify the Brand that contains the Declined Envelope subject that you want to use for that Envelope (if a signer declines to sign).
The answer on this SO thread contains additional info about this procedure, and the docs I've linked to above contain info about branding and the email resource file.
I am using the DocuSign API in an embedded manner. I create an envelope and add signers, the first signer always being set as embedded. This allows me to retrieve a URL that is then embedded in an iframe.
However, I also wish, to trigger an email (as soon as the envelope has been created, NOT upon completion) that gets sent to the primary recipient/signer as if they were a nonembedded signer.
I tried adding the signer twice, with the same role, to the recipients, but that didn't work. No email was sent.
Is there a way to accomplish this?
I believe there is a setting to enable this but that it needs to be enabled by someone on DocuSign's side, like your account manager. If you do not have an account manager yet please respond to the auto-generated emails that were sent out to you once you created your account, you should have 3 of them.
The account settings available are only for Completion emails. However, the REST API also supports an embeddedRecipientStartURL parameter on the signer object that triggers a normal DocuSign email. The value of this parameter is the URL that should be included in the email. This means you can link back to your own application and request the recipient view as normal.
Check here for more detail: Signer embeddedRecipientStartURL. Note: if you set this to a value of "SIGN_AT_DOCUSIGN" then DocuSign will provide its own URL and take care of signing. The trade-off is that you won't be able to initiate any bespoke authentication you are doing in your own application.
Can we customize the DocuSign response(Completed/Voided/Declined) Email Blurb(Content) at runtime on each envelope like Envelope Sending Email Blurb using c#?
It's not possible to customize the Email Blurb for DocuSign Completed/Voided/Declined emails at runtime on a per-envelope basis by using the API. However, it is possible to change the contents of the emails that DocuSign sends for various events (i.e., Completed/Voided/Declined) by customizing the "Email Resource File". This guide contains information about how that's done: https://support.docusign.com/en/guides/docusign-email-resource-file-v1-1.
As the guide shows, a different template within the Email Resource file defines the email content for each email event. For example, the Envelope Declined template within the Email Resource File (described on page 30 of the guide) defines the structure/contents of the email that DocuSign sends to recipients when an Envelope is declined.
Keep in mind that a Resource file is associated with a "Brand" -- so if you have multiple (different) scnearios that you want to customize emails for, you could create multiple Brands and customize the Email Resource file for each, and then specify the desired Brand with each envelope you send (which will set email content for that envelope). Doing things like this would give you somewhat "runtime" control over email contents.
Can we customize the Completion Email Subject as like Email Content using DocuSign Email Resource File? If not, Please let us know what option we can use to implement this?
I am using the embedded signing api using JSON requests to create online signing sessions in the broswser. There is only one prospective configured in the template and the authencitcation method is email.
I do not want the email address that I am sending to receive an email notification. How do I turn this off. Ive looked at preferences--features to turn off email notification but cant find any setting.
Thanks in advance.
Login to the DocuSign web console as an Administrator in the sending DocuSign account, and navigate to Preferences >> Features. Enable (check) the Suppress Emails to Embedded Signers setting and Disable (uncheck) the Use Envelope Complete Email for (non-suppressed) Embedded Signers. Click the SAVE button (all the way at the bottom of the page) to save the changes.
These settings make it so that DocuSign will not send any emails to Recipients that you create via the API and specify as embedded/captive (i.e., by setting clientUserId property to indicate that they will be accessing the Envelope via your application).
Update
If you are using the New DocuSign Experience then follow the instructions here
See the Document delivery section.
I imagine this is something simple and I'm just not looking in the right spot for it.
Is there a way to write a custom email blurb for the completed signing email notification the same way you can generate one for the request for signature notification within the embedded signing API code?
Currently my integration has the first signer embedded, then is emailed to two further recipients. All the requests for signatures have the custom HTML I've created in our application as the "emailBlurb" in the XML request body but I don't see any options to set the message for the completed signing one as well.
Sorry if this is something easy in a FAQ or guide somewhere and I just missed it.
Thanks.
A majority of the Email notifications that DocuSign sends can be customized via modification of the "Email Resource File" (an XML file that contains text strings used in the emails that DocuSign sends). You can access Resource Files via the DocuSign web console (when logged in as an Administrator) by going to Preferences >> Branding >> [Edit Brand] (link) >> Resources (tab).
This guide provides all the information you should need to customize the Resource File:
Note that an Email Resource file applies to a specific "Brand" -- i.e.,all envelopes that use a specific Brand will derive their content from the Email Resource file that's associated with that Brand. It's not currently possible to specify email contents (other than the EmailBlurb in the signing invitation email) via the API. But, depending on the nature of your email customization requirements, you could always create multiple Brands via the DocuSign web console, customize the Email Resource file differently for each Brand, and then set BrandId in each "Create Envelope" API call to affiliate the correct Brand (and therefore email contents) with each envelope.