My company is trying to avoid having many Docusign logins for the group (group X) using Docusign. We were wondering about using one login to do the create, but override the email settings to have it go to members of group X without them having to have Docusign credentials. I was wondering if that would be possible with the replyEmailAddressOverride.
You can do so by using the "Send On Behalf Of" feature where you specify an email address in the authentication header in order to "assign" each transaction to a specific person with the same and unique credentials.
{
"Username": "",//Email of Group X credentials
"Password": "", // Password of Group X credentials
"IntegratorKey": "",// Integrator Key of Group X credentials
"SendOnBehalfOf": "" // Email of the specific person to be assigned the DocuSign transaction
}
If I understand your question correctly, I am not sure that using the replyEmailAddressOverride feature will accommodate what you need.
From the official documentation, this email will be used when the user decided to "reply" to the email sent from DocuSign.
Example in C# below :
EmailSettings settings = new EmailSettings
{
ReplyEmailAddressOverride = "otherUserThanTheSende#fakeemail.com",
ReplyEmailNameOverride = "Other User"
};
envelope.EmailSettings = settings;
If you configure the above email settings, when the signer receives the DocuSign email inviting him to initiate the signing ceremony, if he/she decides to reply to this email, the original DocuSign sender email will not be used but instead the email you have configured will be used.
Example, my "Frederic "account was used to create a transaction so the sender appears as "Frederic" in the DocuSign email. However, when I decide to reply, it doesn't go back to "Frederic" but instead to the user I have configured in the envelope :
But if I understand correctly, you want to send a transaction from a specific sender and this email override setting doesn't affect the transaction sender but the transaction reply.
If you want to use replyEmailAddressOverride and replyEmailNameOverride as present in DS Docs then when an email goes to the signer from DocuSign and if they want to revert to that email then it will go the email which is mentioned in replyEmailAddressOverride property
Related
Is that possible to customize name and company name for each envelope without create all users? or even just hide it?
If this is not possible, what is the recommendations for the following scenario?
We have 5,000 users, they are from different companies(different email domain)
User purchase points on our system, and they use points to buy eSign envelope
We don't want to create 5,000 users under our DocuSign account (not only adding them, we also don't want them to have account to login to DocuSign and create envelope without pay us.
We like to show their name and company in highlight area below
We are OK the email send to the singer is from DocuSign
What you show is the name and company of the sender, the account holder, the person who initiated the request to sign. Not the signer, the person who needs to act on it. Hope this is clear.
You can change the name and company name of the sender/company account programmatically, and then send the next envelope.
However, if you want to do something like this, you won't be able to use bulk send, because it doesn't allow you to make the change between each envelope.
You can run a loop that does this:
Change name/company
Create envelope
Send envelope
Doing this 5000 times also has an issue with API limit (default to 3000/hour) so you will either have to throttle this or contact support to increase your limit
Changing the name of the account holder can be done like this:
Here is C# code for this:
var apiClient = new ApiClient(basePath);
// You will need to obtain an access token using your chosen authentication method
apiClient.Configuration.DefaultHeader.Add("Authorization", "Bearer " + accessToken);
UsersApi usersApi = new UsersApi(apiClient);
UserProfile userProfile = new UserProfile();
userProfile.UserDetails = new UserInformation();
userProfile.UserDetails.FirstName = "Inbar";
userProfile.UserDetails.LastName = "Gazit";
usersApi.UpdateProfile(accountId, userId, userProfile);
You can find all other langs and more details here - https://www.docusign.com/blog/developers/common-api-tasks-update-the-name-docusign-user
After running the console app, our users get an email with the signing link to Docusign making them remote signers.
What I want to be able to do is get those links from their emails.
I did some research and this is what each url is made of
https://demo.docusign.net/Member/EmailStart.aspx?
a=65d11cf7-d3b7-49a1-8000-6192b6227d71& <<< Unique Activity ID? Always different in all URLs
acct=a0e816ac-3919-475e-a826-34c2c33f90e7& <<< Some kind of role ID (stays same between envelopes and users of the same role, I have it
for my roles..just don't know how to get it programmatically
er=62378ec0-39ce-495e-84e4-e0e598fab3cc& <<<< envelopesApi.ListRecipients(.....) .Signers[n].RecipientIdGuid, able to get it
espei=30cec285-39cd-45a3-bb8e-7bd0560dcd80 <<<< ENVELOPE ID, able to get it
The first parameter is the main focus of my question - it is a total mistery what is it and how to get it
The second parameter looks like a role_id, but I don't know how to get it other than hard-coding values for each of my roles
The other two parameters aren't a concern.
Does anybody know how to get ahold of the first two parameters using the C# Docusign API?
Or even better, is there a way to get the recipients signing url links using the same API?
To obtain the signing URL you will have to set the recipient as an embedded recipient.
After the envelope is created, use the createRecipient:EnvelopeViews api to retrieve the Signing URL.
You have to set the recipient clientUserId parameter to mark a recipient as an embedded recipient.
Request
{
"userName": "name",
"email": "examble#email.com",
"clientUserId": "clientUserId",
"authenticationMethod": "email",
"returnUrl": "your app url"
}
I'm trying to receive the Recipient Url for embedded signing within our application.
I won't have the user's credentials, and all my API calls are going through as a Ds administrator account.
When I execute the following I get an error message:
{
"errorCode": "ACCOUNT_NOT_AUTHORIZED_FOR_ENVELOPE",
"message": "This account is not authorized to access the requested envelope."
}
If I execute this against envelopes that are assigned to me it works fine but not other users. I should also point out we are not currently making use of clientUserId when creating recipients. Only a small portion will need embedded signing.
It was my understanding an administrative account would be able to retrieve the url needed to begin the embeded signing process. Is this not correct?
Also under what circumstances would email and userName not be the same? Aren't usernames always email addresses?
Request :
POST https://demo.docusign.net/restapi/v2/accounts/244043/envelopes/41d02a5f-13f8-4fb5-897d-142e1c653645/views/recipient
X-DocuSign-Authentication: <DocuSignCredentials><Username>blah</Username><Password>blah2</Password><IntegratorKey>blah3</IntegratorKey></DocuSignCredentials>
Content-Type: application/json
{
"returnUrl": "http://www.[somedomain].com",
"email" : "someguy#gmail.com",
"userName" : "someguy#gmail.com",
"authenticationMethod" : "email"
}
EDIT:
Additionally if I try the following for my request :
{
"returnUrl": "http://www.[mydomain].com",
"userId" : "xxxxx-xxx-xxxx-xxx-xxxxxxxxxx",
"authenticationMethod" : "email"
}
I receive :
{
errorCode: "INVALID_USERID"
message: "Invalid UserId. UserId specified in request does not match authenticated user."
}
In addition to the issues in Luis Scott's answer, you're missing one of the required parameters for the Recipient View method --
clientUserId A sender created value that shows [that] the recipient is embedded (captive). Maximum of 100 characters.
Create a value for the clientUserId and include it for the signer when you create the transaction (when you send the signing request).
Then include it when you want the Recipient View. It's a security measure to ensure that it is ok for your web app to authenticate the signer.
Only include the clientUserId for signers where you can authenticate them yourself and you plan to offer them the embedded signing view.
1) Please ensure the user being used for the API calls has the "Account-Wide Rights" setting enabled under preferences -> users -> permissions.
2) The Username field should be the recipients full name that was provided during envelope creation. So it would be "Some Guy" IMO using your sample above.
I would like to preserve the Email Subject & email Message that are defined on the Docusign Template and send those vs sending generic email subject & message when sending a document via Custom Button in Salesforce? Below is my button code
{!REQUIRESCRIPT("/apex/dsfs__DocuSign_JavaScript")}
var DST='<Docusign Template Id>';
var LA='0';
var OSO = 'Send';
var CRL = 'Email~{!Fulfillment__c.Primary_Contact_Email__c};Role~Client;FirstName~ {!Fulfillment__c.Primary_Contact_First_Name__c};LastName~{!Fulfillment__c.Primary_Contact_Last_Name__c}';
var CCRM='Client~Client';
window.location.href = '/apex/dsfs__DocuSign_CreateEnvelope?DSEID=0&SourceID='+eSignatureNotSent.Id+'&DST='+DST+'&LA='+LA+'&CRL='+CRL+'&OCO='+OCO+'&CCRM='+CCRM;
I think Docusign is using Default Email Subject and Default Email Message defined in the Admin settings in Salesforce. I do not want to send it as all the work is done when building templates in Docusign.
If you leave the Default Email Message blank in the Admin settings, it will grab the contents of the Template Email Message.
The API has a hard requirement to define an email subject through the request. Currently because Salesforce uses the API, it has to follow this guideline.
My best advice is making a custom button that defines the Email subject that you'd like for each workflow that you may have.
Not received email that was typed in textbox "Email Address" using dialog "Save your Copy" in "In Person" signing.
While signing the envelope in In-Person mode there is an window (popup) to send a copy of the document in an email. We have entered the email (many times and different email services) but no email received. Checked settings in the DocuSign portal account but not able to find any setting for this. Please let us know how to enable the save a copy email in DocuSign.
We using DocuSign SOAP API under C#.
For InPererson Recipient we add :
new Recipient
{
Email = "email of host recipient",
UserName = "name of host recipient",
SignerName = "name of current recipient",
ID = "id current recipient",
Type = RecipientTypeCode.InPersonSigner,
RoutingOrder = 2,
RequireIDLookup = false,
CaptiveInfo =
new RecipientCaptiveInfo {ClientUserId = "special id of current recipient"}
};
And we open docusign token url (RequestRecipientToken method) in new browser window without iframe we open it in IE 8-11 and Google Chrome
What we have to specify in addition to this , when creating and sending envelope or in account preferences of main account in docusign.com?
First, keep in mind that the email you're describing will only be sent upon Completion of the Envelope -- so if there are other recipients after the In-Person signer in the routing order for the Envelope, the In-Person signer wouldn't receive the email until all recipients have completed their required actions and the Envelope is complete.
Second, you might want to verify (in Preferences >> Features within the DocuSign web console) that these two settings are set as shown here:
These settings control whether or not emails are sent to "embedded/captive" recipients. Even though you're using "In-Person" signing -- it sounds like you're launching the host's signing session using "Embedded Signing" (i.e., RequestRecipientToken), so these settings might be affecting whether or not the email actually gets sent to the signer.