BulksignApi Web Service

BulksignApi

Click here for a complete list of operations.

AddEmailTemplate

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 /webapi/bulksignapi.asmx HTTP/1.1
Host: bulksign.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://bulksign.com/AddEmailTemplate"

<?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>
    <AddEmailTemplate xmlns="http://bulksign.com/">
      <authenticationToken>
        <UserEmail>string</UserEmail>
        <Key>string</Key>
      </authenticationToken>
      <model>
        <Language>string</Language>
        <Templates>
          <EmailTemplateDescriptorApiModel>
            <TemplateType>Main or Sign or EnvelopeExpiredSender or EnvelopeExpiredRecipient or ActivateEmail or UserInvitation or SignStepRejected or SignStepFinished or EnvelopeCompleted or SignStepOpened or EnvelopeCanceled or ForgotPassword or SendCompletedDocumentsToReceiveCopyRecipients or DeliveryNotificationError or SendFinishedSignStepDocumentToSigner or RecipientDelegatedToSender or RecipientDelegationActionRequestToSender or SendCompletedDocumentsLinkToReceiveCopyRecipients</TemplateType>
            <Subject>string</Subject>
            <Body>string</Body>
          </EmailTemplateDescriptorApiModel>
          <EmailTemplateDescriptorApiModel>
            <TemplateType>Main or Sign or EnvelopeExpiredSender or EnvelopeExpiredRecipient or ActivateEmail or UserInvitation or SignStepRejected or SignStepFinished or EnvelopeCompleted or SignStepOpened or EnvelopeCanceled or ForgotPassword or SendCompletedDocumentsToReceiveCopyRecipients or DeliveryNotificationError or SendFinishedSignStepDocumentToSigner or RecipientDelegatedToSender or RecipientDelegationActionRequestToSender or SendCompletedDocumentsLinkToReceiveCopyRecipients</TemplateType>
            <Subject>string</Subject>
            <Body>string</Body>
          </EmailTemplateDescriptorApiModel>
        </Templates>
      </model>
    </AddEmailTemplate>
  </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>
    <AddEmailTemplateResponse xmlns="http://bulksign.com/">
      <AddEmailTemplateResult>
        <ErrorMessage>string</ErrorMessage>
        <IsSuccessful>boolean</IsSuccessful>
        <Response>string</Response>
        <ErrorCode>int</ErrorCode>
        <RequestId>string</RequestId>
      </AddEmailTemplateResult>
    </AddEmailTemplateResponse>
  </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 /webapi/bulksignapi.asmx HTTP/1.1
Host: bulksign.com
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>
    <AddEmailTemplate xmlns="http://bulksign.com/">
      <authenticationToken>
        <UserEmail>string</UserEmail>
        <Key>string</Key>
      </authenticationToken>
      <model>
        <Language>string</Language>
        <Templates>
          <EmailTemplateDescriptorApiModel>
            <TemplateType>Main or Sign or EnvelopeExpiredSender or EnvelopeExpiredRecipient or ActivateEmail or UserInvitation or SignStepRejected or SignStepFinished or EnvelopeCompleted or SignStepOpened or EnvelopeCanceled or ForgotPassword or SendCompletedDocumentsToReceiveCopyRecipients or DeliveryNotificationError or SendFinishedSignStepDocumentToSigner or RecipientDelegatedToSender or RecipientDelegationActionRequestToSender or SendCompletedDocumentsLinkToReceiveCopyRecipients</TemplateType>
            <Subject>string</Subject>
            <Body>string</Body>
          </EmailTemplateDescriptorApiModel>
          <EmailTemplateDescriptorApiModel>
            <TemplateType>Main or Sign or EnvelopeExpiredSender or EnvelopeExpiredRecipient or ActivateEmail or UserInvitation or SignStepRejected or SignStepFinished or EnvelopeCompleted or SignStepOpened or EnvelopeCanceled or ForgotPassword or SendCompletedDocumentsToReceiveCopyRecipients or DeliveryNotificationError or SendFinishedSignStepDocumentToSigner or RecipientDelegatedToSender or RecipientDelegationActionRequestToSender or SendCompletedDocumentsLinkToReceiveCopyRecipients</TemplateType>
            <Subject>string</Subject>
            <Body>string</Body>
          </EmailTemplateDescriptorApiModel>
        </Templates>
      </model>
    </AddEmailTemplate>
  </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>
    <AddEmailTemplateResponse xmlns="http://bulksign.com/">
      <AddEmailTemplateResult>
        <ErrorMessage>string</ErrorMessage>
        <IsSuccessful>boolean</IsSuccessful>
        <Response>string</Response>
        <ErrorCode>int</ErrorCode>
        <RequestId>string</RequestId>
      </AddEmailTemplateResult>
    </AddEmailTemplateResponse>
  </soap12:Body>
</soap12:Envelope>