BulksignApi


Click here for a complete list of operations.

SendEnvelopeFromTemplate

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/SendEnvelopeFromTemplate"

<?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>
    <SendEnvelopeFromTemplate xmlns="http://bulksign.com/">
      <authenticationToken>
        <UserEmail>string</UserEmail>
        <Key>string</Key>
      </authenticationToken>
      <templateContext>
        <TemplateId>string</TemplateId>
        <ReplaceRecipients>
          <TemplateReplaceRecipientApiModel>
            <ByIndex xsi:nil="true" />
            <ByEmail xsi:nil="true" />
            <Email>string</Email>
            <Name>string</Name>
            <PhoneNumber>string</PhoneNumber>
            <PersonalMessage>string</PersonalMessage>
            <RecipientAuthenticationMethods xsi:nil="true" />
          </TemplateReplaceRecipientApiModel>
          <TemplateReplaceRecipientApiModel>
            <ByIndex xsi:nil="true" />
            <ByEmail xsi:nil="true" />
            <Email>string</Email>
            <Name>string</Name>
            <PhoneNumber>string</PhoneNumber>
            <PersonalMessage>string</PersonalMessage>
            <RecipientAuthenticationMethods xsi:nil="true" />
          </TemplateReplaceRecipientApiModel>
        </ReplaceRecipients>
        <ReplaceFormFields>
          <TemplateReplaceFormFieldsApiModel>
            <FindDocumentByIndex>int</FindDocumentByIndex>
            <FindDocumentByName>string</FindDocumentByName>
            <FormFieldValues xsi:nil="true" />
          </TemplateReplaceFormFieldsApiModel>
          <TemplateReplaceFormFieldsApiModel>
            <FindDocumentByIndex>int</FindDocumentByIndex>
            <FindDocumentByName>string</FindDocumentByName>
            <FormFieldValues xsi:nil="true" />
          </TemplateReplaceFormFieldsApiModel>
        </ReplaceFormFields>
      </templateContext>
    </SendEnvelopeFromTemplate>
  </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>
    <SendEnvelopeFromTemplateResponse xmlns="http://bulksign.com/">
      <SendEnvelopeFromTemplateResult>
        <ErrorMessage>string</ErrorMessage>
        <IsSuccessful>boolean</IsSuccessful>
        <Response>
          <EnvelopeId>string</EnvelopeId>
          <RecipientAccess>
            <RecipientAccessApiModel xsi:nil="true" />
            <RecipientAccessApiModel xsi:nil="true" />
          </RecipientAccess>
        </Response>
        <ErrorCode>int</ErrorCode>
        <RequestId>string</RequestId>
      </SendEnvelopeFromTemplateResult>
    </SendEnvelopeFromTemplateResponse>
  </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>
    <SendEnvelopeFromTemplate xmlns="http://bulksign.com/">
      <authenticationToken>
        <UserEmail>string</UserEmail>
        <Key>string</Key>
      </authenticationToken>
      <templateContext>
        <TemplateId>string</TemplateId>
        <ReplaceRecipients>
          <TemplateReplaceRecipientApiModel>
            <ByIndex xsi:nil="true" />
            <ByEmail xsi:nil="true" />
            <Email>string</Email>
            <Name>string</Name>
            <PhoneNumber>string</PhoneNumber>
            <PersonalMessage>string</PersonalMessage>
            <RecipientAuthenticationMethods xsi:nil="true" />
          </TemplateReplaceRecipientApiModel>
          <TemplateReplaceRecipientApiModel>
            <ByIndex xsi:nil="true" />
            <ByEmail xsi:nil="true" />
            <Email>string</Email>
            <Name>string</Name>
            <PhoneNumber>string</PhoneNumber>
            <PersonalMessage>string</PersonalMessage>
            <RecipientAuthenticationMethods xsi:nil="true" />
          </TemplateReplaceRecipientApiModel>
        </ReplaceRecipients>
        <ReplaceFormFields>
          <TemplateReplaceFormFieldsApiModel>
            <FindDocumentByIndex>int</FindDocumentByIndex>
            <FindDocumentByName>string</FindDocumentByName>
            <FormFieldValues xsi:nil="true" />
          </TemplateReplaceFormFieldsApiModel>
          <TemplateReplaceFormFieldsApiModel>
            <FindDocumentByIndex>int</FindDocumentByIndex>
            <FindDocumentByName>string</FindDocumentByName>
            <FormFieldValues xsi:nil="true" />
          </TemplateReplaceFormFieldsApiModel>
        </ReplaceFormFields>
      </templateContext>
    </SendEnvelopeFromTemplate>
  </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>
    <SendEnvelopeFromTemplateResponse xmlns="http://bulksign.com/">
      <SendEnvelopeFromTemplateResult>
        <ErrorMessage>string</ErrorMessage>
        <IsSuccessful>boolean</IsSuccessful>
        <Response>
          <EnvelopeId>string</EnvelopeId>
          <RecipientAccess>
            <RecipientAccessApiModel xsi:nil="true" />
            <RecipientAccessApiModel xsi:nil="true" />
          </RecipientAccess>
        </Response>
        <ErrorCode>int</ErrorCode>
        <RequestId>string</RequestId>
      </SendEnvelopeFromTemplateResult>
    </SendEnvelopeFromTemplateResponse>
  </soap12:Body>
</soap12:Envelope>