soap

Click here for a complete list of operations.

AddContact

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
developerEmail:
developerAPIkey:
contactEmail:
contactName:
countryCode:
contactAddress1:
contactAddress2:
contactPhone:
contactCity:
contactState:
contactZipCode:

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 /soap.asmx HTTP/1.1
Host: api.pixelz.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://removethebackground.com/AddContact"

<?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>
    <AddContact xmlns="http://removethebackground.com/">
      <developerEmail>string</developerEmail>
      <developerAPIkey>string</developerAPIkey>
      <contactEmail>string</contactEmail>
      <contactName>string</contactName>
      <countryCode>string</countryCode>
      <contactAddress1>string</contactAddress1>
      <contactAddress2>string</contactAddress2>
      <contactPhone>string</contactPhone>
      <contactCity>string</contactCity>
      <contactState>string</contactState>
      <contactZipCode>string</contactZipCode>
    </AddContact>
  </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>
    <AddContactResponse xmlns="http://removethebackground.com/">
      <AddContactResult>
        <ContactEmail>string</ContactEmail>
        <ContactAPIkey>string</ContactAPIkey>
      </AddContactResult>
    </AddContactResponse>
  </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 /soap.asmx HTTP/1.1
Host: api.pixelz.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>
    <AddContact xmlns="http://removethebackground.com/">
      <developerEmail>string</developerEmail>
      <developerAPIkey>string</developerAPIkey>
      <contactEmail>string</contactEmail>
      <contactName>string</contactName>
      <countryCode>string</countryCode>
      <contactAddress1>string</contactAddress1>
      <contactAddress2>string</contactAddress2>
      <contactPhone>string</contactPhone>
      <contactCity>string</contactCity>
      <contactState>string</contactState>
      <contactZipCode>string</contactZipCode>
    </AddContact>
  </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>
    <AddContactResponse xmlns="http://removethebackground.com/">
      <AddContactResult>
        <ContactEmail>string</ContactEmail>
        <ContactAPIkey>string</ContactAPIkey>
      </AddContactResult>
    </AddContactResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /soap.asmx/AddContact?developerEmail=string&developerAPIkey=string&contactEmail=string&contactName=string&countryCode=string&contactAddress1=string&contactAddress2=string&contactPhone=string&contactCity=string&contactState=string&contactZipCode=string HTTP/1.1
Host: api.pixelz.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<NewContactResponse xmlns="http://removethebackground.com/">
  <ContactEmail>string</ContactEmail>
  <ContactAPIkey>string</ContactAPIkey>
</NewContactResponse>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /soap.asmx/AddContact HTTP/1.1
Host: api.pixelz.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

developerEmail=string&developerAPIkey=string&contactEmail=string&contactName=string&countryCode=string&contactAddress1=string&contactAddress2=string&contactPhone=string&contactCity=string&contactState=string&contactZipCode=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<NewContactResponse xmlns="http://removethebackground.com/">
  <ContactEmail>string</ContactEmail>
  <ContactAPIkey>string</ContactAPIkey>
</NewContactResponse>