ContactList_UpdateInsert

Updates any number of Contact records. Uses ExternalID as unique key. If ExternalID is not present then email address is used as unique key.

Warning: This API endpoint will eventually be deprecated (existing implementations will still continue to work). We strongly advise to use the new CRM v3 REST API endpoints. Here is an example on how to edit an existing a CRM record by email address or how to edit an existing a CRM record by ID or create a new CRM record using the new endpoints.

Request

  • Method: SOAP
  • Server: https://[app key here]-[site_ID here]-apps.worldsecuresystems.com. Take a look at the Authorize your API calls document for more info on how this URL is formed.
  • Path: /catalystwebservice/catalystcrmwebservice.asmx
  • The username and password fields:You can make SOAP API calls can be authorized either by using the actual username or password of an Admin username or, if you are making the calls from an app leave the username field empty and use the authorization token as the password.

Parameters

  • siteId - ID of the site (integer)
  • username - email address of user account, leave empty if using site token (string)
  • password - password of user account, or site authentication token for specified site (string)
  • contactsList - (object)
    • ContactRecord - (object)
      • entityId - (integer)
      • externalId - (string)
      • emailAddress - (string)
      • contactTitle - (string)
      • deleted - (boolean)
      • fullName - (string)
      • firstName - (string)
      • lastName - (string)
      • username - (string)
      • password - (string)
      • dateOfBirth - (dateTime) - e.g. 2014-09-9T10:24:00
      • createDate - (dateTime) - e.g. 2014-09-9T10:24:00
      • lastUpdateDate - (dateTime) - e.g. 2014-09-9T10:24:00
      • customerType - (string)
      • industryType - (string)
      • leadSourceType - (string)
      • ratingType - (string)
      • relationships - (array)
      • addresses - (array)
      • phoneNos - (array)
      • crmForms - (array)
      • MasterOptIn - (boolean)

To use a site token instead of username/password, send an empty username field and the site token as the password. See example below.

Response

An empty ContactList_UpdateInsertResponse object with a header response code

Examples

Accepts and returns XML as Content-Type.

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values, please note the data in the request and response is only for explanatory purposes.

Request:

POST /catalystwebservice/catalystcrmwebservice.asmx HTTP/1.1
Host: worldsecuresystems.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>
    <ContactList_UpdateInsert xmlns="http://tempuri.org/CatalystDeveloperService/CatalystCRMWebservice">
      <username>jdoe@yourdomain.com</username>
      <password>Y0urP@ssw0rdH3re</password>
      <siteId>12345</siteId>
      <contactsList>
        <ContactRecord>
          <entityId>1234</entityId>
          <externalId>12345</externalId>
          <emailAddress>jdoe@yourdomain.com</emailAddress>
          <contactTitle>string</contactTitle>
          <deleted>false</deleted>
          <fullName>John Doe</fullName>
          <firstName>John</firstName>
          <lastName>Doe</lastName>
          <username>jdoe@yourdomain.com</username>
          <password>Y0urP@ssw0rdH3re</password>
          <dateOfBirth>1980-03-03T10:20:00</dateOfBirth>
          <createDate>2010-08-08T12:22:00</createDate>
          <lastUpdateDate>2012-08-08T12:22:00</lastUpdateDate>
          <customerType>string</customerType>
          <industryType>string</industryType>
          <leadSourceType>string</leadSourceType>
          <ratingType>string</ratingType>
          <relationships>
            <Relationship xsi:nil="true" />
            <Relationship xsi:nil="true" />
          </relationships>
          <addresses>
            <Address xsi:nil="true" />
            <Address xsi:nil="true" />
          </addresses>
          <phoneNos>
            <PhoneNo xsi:nil="true" />
            <PhoneNo xsi:nil="true" />
          </phoneNos>
          <crmForms>
            <CrmForms xsi:nil="true" />
            <CrmForms xsi:nil="true" />
          </crmForms>
          <MasterOptIn>true</MasterOptIn>
        </ContactRecord>
        <ContactRecord>
          <entityId>1234</entityId>
          <externalId>12345</externalId>
          <emailAddress>jdoe@yourdomain.com</emailAddress>
          <contactTitle>string</contactTitle>
          <deleted>false</deleted>
          <fullName>John Doe</fullName>
          <firstName>John</firstName>
          <lastName>Doe</lastName>
          <username>jdoe@yourdomain.com</username>
          <password>Y0urP@ssw0rdH3re</password>
          <dateOfBirth>1980-03-03T10:20:00</dateOfBirth>
          <createDate>2010-08-08T12:22:00</createDate>
          <lastUpdateDate>2012-08-08T12:22:00</lastUpdateDate>
          <customerType>string</customerType>
          <industryType>string</industryType>
          <leadSourceType>string</leadSourceType>
          <ratingType>string</ratingType>
          <relationships>
            <Relationship xsi:nil="true" />
            <Relationship xsi:nil="true" />
          </relationships>
          <addresses>
            <Address xsi:nil="true" />
            <Address xsi:nil="true" />
          </addresses>
          <phoneNos>
            <PhoneNo xsi:nil="true" />
            <PhoneNo xsi:nil="true" />
          </phoneNos>
          <crmForms>
            <CrmForms xsi:nil="true" />
            <CrmForms xsi:nil="true" />
          </crmForms>
          <MasterOptIn>true</MasterOptIn>
        </ContactRecord>
      </contactsList>
    </ContactList_UpdateInsert>
  </soap12:Body>
</soap12:Envelope>

Response:

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>
    <ContactList_UpdateInsertResponse xmlns="http://tempuri.org/CatalystDeveloperService/CatalystCRMWebservice" />
  </soap12:Body>
</soap12:Envelope>