BulksignApi


Click here for a complete list of operations.

ReplaceEnvelopeRecipient

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

<?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>
    <ReplaceEnvelopeRecipient xmlns="http://bulksign.com/">
      <authenticationToken>
        <UserEmail>string</UserEmail>
        <Key>string</Key>
      </authenticationToken>
      <replace>
        <EnvelopeId>string</EnvelopeId>
        <ByIndex>
          <Index>int</Index>
        </ByIndex>
        <ByEmail>
          <RecipientEmail>string</RecipientEmail>
          <RecipientType>Signer or ReceivesCopy or AutomaticSigner or Approver</RecipientType>
        </ByEmail>
        <Email>string</Email>
        <Name>string</Name>
        <PhoneNumber>string</PhoneNumber>
        <PersonalMessage>string</PersonalMessage>
        <RecipientAuthenticationMethods>
          <RecipientAuthenticationApiModel>
            <AuthenticationType>Password or SMS or AuthenticationProvider</AuthenticationType>
            <Details>string</Details>
          </RecipientAuthenticationApiModel>
          <RecipientAuthenticationApiModel>
            <AuthenticationType>Password or SMS or AuthenticationProvider</AuthenticationType>
            <Details>string</Details>
          </RecipientAuthenticationApiModel>
        </RecipientAuthenticationMethods>
        <AutomaticSignerProfileIdentifier>string</AutomaticSignerProfileIdentifier>
      </replace>
    </ReplaceEnvelopeRecipient>
  </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>
    <ReplaceEnvelopeRecipientResponse xmlns="http://bulksign.com/">
      <ReplaceEnvelopeRecipientResult>
        <ErrorMessage>string</ErrorMessage>
        <IsSuccessful>boolean</IsSuccessful>
        <Response>string</Response>
        <ErrorCode>int</ErrorCode>
        <RequestId>string</RequestId>
      </ReplaceEnvelopeRecipientResult>
    </ReplaceEnvelopeRecipientResponse>
  </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>
    <ReplaceEnvelopeRecipient xmlns="http://bulksign.com/">
      <authenticationToken>
        <UserEmail>string</UserEmail>
        <Key>string</Key>
      </authenticationToken>
      <replace>
        <EnvelopeId>string</EnvelopeId>
        <ByIndex>
          <Index>int</Index>
        </ByIndex>
        <ByEmail>
          <RecipientEmail>string</RecipientEmail>
          <RecipientType>Signer or ReceivesCopy or AutomaticSigner or Approver</RecipientType>
        </ByEmail>
        <Email>string</Email>
        <Name>string</Name>
        <PhoneNumber>string</PhoneNumber>
        <PersonalMessage>string</PersonalMessage>
        <RecipientAuthenticationMethods>
          <RecipientAuthenticationApiModel>
            <AuthenticationType>Password or SMS or AuthenticationProvider</AuthenticationType>
            <Details>string</Details>
          </RecipientAuthenticationApiModel>
          <RecipientAuthenticationApiModel>
            <AuthenticationType>Password or SMS or AuthenticationProvider</AuthenticationType>
            <Details>string</Details>
          </RecipientAuthenticationApiModel>
        </RecipientAuthenticationMethods>
        <AutomaticSignerProfileIdentifier>string</AutomaticSignerProfileIdentifier>
      </replace>
    </ReplaceEnvelopeRecipient>
  </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>
    <ReplaceEnvelopeRecipientResponse xmlns="http://bulksign.com/">
      <ReplaceEnvelopeRecipientResult>
        <ErrorMessage>string</ErrorMessage>
        <IsSuccessful>boolean</IsSuccessful>
        <Response>string</Response>
        <ErrorCode>int</ErrorCode>
        <RequestId>string</RequestId>
      </ReplaceEnvelopeRecipientResult>
    </ReplaceEnvelopeRecipientResponse>
  </soap12:Body>
</soap12:Envelope>