DSAPIService
Click here for a complete list of operations.
SaveTemplate
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /api/3.0/dsapi.asmx HTTP/1.1 Host: na2.docusign.net Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.docusign.net/API/3.0/SaveTemplate" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <SaveTemplate xmlns="http://www.docusign.net/API/3.0"> <EnvelopeTemplate> <EnvelopeTemplateDefinition> <TemplateID>string</TemplateID> <Name>string</Name> <Shared>boolean</Shared> <TemplatePassword>string</TemplatePassword> <TemplateDescription>string</TemplateDescription> <LastModified>dateTime</LastModified> <PageCount>int</PageCount> </EnvelopeTemplateDefinition> <Envelope> <TransactionID>string</TransactionID> <Asynchronous>boolean</Asynchronous> <AccountId>string</AccountId> <Documents> <Document xsi:nil="true" /> <Document xsi:nil="true" /> </Documents> <Recipients> <Recipient xsi:nil="true" /> <Recipient xsi:nil="true" /> </Recipients> <Tabs> <Tab xsi:nil="true" /> <Tab xsi:nil="true" /> </Tabs> <Subject>string</Subject> <EmailBlurb>string</EmailBlurb> <SigningLocation>InPerson or Online</SigningLocation> <CustomFields> <CustomField xsi:nil="true" /> <CustomField xsi:nil="true" /> </CustomFields> <VaultingOptions> <VaultingMode>None or EODeStore or EODAuthoritativeCopy</VaultingMode> <EODTransactionName>string</EODTransactionName> <EODDocumentName>string</EODDocumentName> <EODDocumentDescription>string</EODDocumentDescription> </VaultingOptions> <AutoNavigation>boolean</AutoNavigation> <EnvelopeIdStamping>boolean</EnvelopeIdStamping> <AuthoritativeCopy>boolean</AuthoritativeCopy> <Notification> <UseAccountDefaults>boolean</UseAccountDefaults> <Reminders xsi:nil="true" /> <Expirations xsi:nil="true" /> </Notification> <EnvelopeAttachment> <Attachment xsi:nil="true" /> <Attachment xsi:nil="true" /> </EnvelopeAttachment> <EnforceSignerVisibility>boolean</EnforceSignerVisibility> <EnableWetSign>boolean</EnableWetSign> <AllowMarkup>boolean</AllowMarkup> <EventNotification> <URL>string</URL> <LoggingEnabled>boolean</LoggingEnabled> <RequireAcknowledgment>boolean</RequireAcknowledgment> <UseSoapInterface>boolean</UseSoapInterface> <SoapNameSpace>string</SoapNameSpace> <IncludeCertificateWithSoap>boolean</IncludeCertificateWithSoap> <SignMessageWithX509Cert>boolean</SignMessageWithX509Cert> <IncludeDocuments>boolean</IncludeDocuments> <IncludeHMAC>boolean</IncludeHMAC> <IncludeTimeZone>boolean</IncludeTimeZone> <IncludeEnvelopeVoidReason>boolean</IncludeEnvelopeVoidReason> <IncludeDocumentFields>boolean</IncludeDocumentFields> <IncludeCertificateOfCompletion>boolean</IncludeCertificateOfCompletion> <IncludeSenderAccountAsCustomField>boolean</IncludeSenderAccountAsCustomField> <EnvelopeEvents xsi:nil="true" /> <RecipientEvents xsi:nil="true" /> </EventNotification> <AllowReassign>boolean</AllowReassign> <BrandId>string</BrandId> <BrandLock>boolean</BrandLock> <Accessibility>string</Accessibility> <MessageLock>boolean</MessageLock> <RecipientsLock>boolean</RecipientsLock> <UseDisclosure>boolean</UseDisclosure> <EmailSettings> <ReplyEmailAddressOverride>string</ReplyEmailAddressOverride> <ReplyEmailNameOverride>string</ReplyEmailNameOverride> <BCCEmailAddresses xsi:nil="true" /> </EmailSettings> <AuthoritativeCopyDefault>boolean</AuthoritativeCopyDefault> </Envelope> </EnvelopeTemplate> </SaveTemplate> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <SaveTemplateResponse xmlns="http://www.docusign.net/API/3.0"> <SaveTemplateResult> <Success>boolean</Success> <TemplateID>string</TemplateID> <Name>string</Name> </SaveTemplateResult> </SaveTemplateResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /api/3.0/dsapi.asmx HTTP/1.1 Host: na2.docusign.net Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <SaveTemplate xmlns="http://www.docusign.net/API/3.0"> <EnvelopeTemplate> <EnvelopeTemplateDefinition> <TemplateID>string</TemplateID> <Name>string</Name> <Shared>boolean</Shared> <TemplatePassword>string</TemplatePassword> <TemplateDescription>string</TemplateDescription> <LastModified>dateTime</LastModified> <PageCount>int</PageCount> </EnvelopeTemplateDefinition> <Envelope> <TransactionID>string</TransactionID> <Asynchronous>boolean</Asynchronous> <AccountId>string</AccountId> <Documents> <Document xsi:nil="true" /> <Document xsi:nil="true" /> </Documents> <Recipients> <Recipient xsi:nil="true" /> <Recipient xsi:nil="true" /> </Recipients> <Tabs> <Tab xsi:nil="true" /> <Tab xsi:nil="true" /> </Tabs> <Subject>string</Subject> <EmailBlurb>string</EmailBlurb> <SigningLocation>InPerson or Online</SigningLocation> <CustomFields> <CustomField xsi:nil="true" /> <CustomField xsi:nil="true" /> </CustomFields> <VaultingOptions> <VaultingMode>None or EODeStore or EODAuthoritativeCopy</VaultingMode> <EODTransactionName>string</EODTransactionName> <EODDocumentName>string</EODDocumentName> <EODDocumentDescription>string</EODDocumentDescription> </VaultingOptions> <AutoNavigation>boolean</AutoNavigation> <EnvelopeIdStamping>boolean</EnvelopeIdStamping> <AuthoritativeCopy>boolean</AuthoritativeCopy> <Notification> <UseAccountDefaults>boolean</UseAccountDefaults> <Reminders xsi:nil="true" /> <Expirations xsi:nil="true" /> </Notification> <EnvelopeAttachment> <Attachment xsi:nil="true" /> <Attachment xsi:nil="true" /> </EnvelopeAttachment> <EnforceSignerVisibility>boolean</EnforceSignerVisibility> <EnableWetSign>boolean</EnableWetSign> <AllowMarkup>boolean</AllowMarkup> <EventNotification> <URL>string</URL> <LoggingEnabled>boolean</LoggingEnabled> <RequireAcknowledgment>boolean</RequireAcknowledgment> <UseSoapInterface>boolean</UseSoapInterface> <SoapNameSpace>string</SoapNameSpace> <IncludeCertificateWithSoap>boolean</IncludeCertificateWithSoap> <SignMessageWithX509Cert>boolean</SignMessageWithX509Cert> <IncludeDocuments>boolean</IncludeDocuments> <IncludeHMAC>boolean</IncludeHMAC> <IncludeTimeZone>boolean</IncludeTimeZone> <IncludeEnvelopeVoidReason>boolean</IncludeEnvelopeVoidReason> <IncludeDocumentFields>boolean</IncludeDocumentFields> <IncludeCertificateOfCompletion>boolean</IncludeCertificateOfCompletion> <IncludeSenderAccountAsCustomField>boolean</IncludeSenderAccountAsCustomField> <EnvelopeEvents xsi:nil="true" /> <RecipientEvents xsi:nil="true" /> </EventNotification> <AllowReassign>boolean</AllowReassign> <BrandId>string</BrandId> <BrandLock>boolean</BrandLock> <Accessibility>string</Accessibility> <MessageLock>boolean</MessageLock> <RecipientsLock>boolean</RecipientsLock> <UseDisclosure>boolean</UseDisclosure> <EmailSettings> <ReplyEmailAddressOverride>string</ReplyEmailAddressOverride> <ReplyEmailNameOverride>string</ReplyEmailNameOverride> <BCCEmailAddresses xsi:nil="true" /> </EmailSettings> <AuthoritativeCopyDefault>boolean</AuthoritativeCopyDefault> </Envelope> </EnvelopeTemplate> </SaveTemplate> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <SaveTemplateResponse xmlns="http://www.docusign.net/API/3.0"> <SaveTemplateResult> <Success>boolean</Success> <TemplateID>string</TemplateID> <Name>string</Name> </SaveTemplateResult> </SaveTemplateResponse> </soap12:Body> </soap12:Envelope>