What is Version 4?

In order to accommodate multiple prospects with the same email address, we have created a new version of our APIs - version 4. If your Pardot org has this feature enabled now, then you must use version 4. If your Pardot org does not have this featured enabled, you must use version 3.

To determine if your Pardot org has this feature enabled, check out this guide.

For more information on the API in general, check out the Overview Page.

For specific API endpoints, please select from the "Version 4" list above.

Transitioning from version 3 to version 4

If you are going to upgrade your Pardot org to allow multiple prospects with the same email address, and you use the api, you will need to follow the guidelines below.

Determining when these changes are applicable

As soon your Pardot org is upgraded to allow multiple prospects with the same email address, your current API session will be cleared and you must log in again. Upon logging in, a new field will be returned in the login response. This will be your indication that you may no longer use version 3 (or any other previous version), and must now use the version 4 syntax. Here's what that will look like:

Request:

POST: https://pi.pardot.com/api/login/version/3
message body: email=<email>&password=<password>&user_key=<user_key>

Response (Before transition):

<rsp stat="ok" version="1.0">
  <api_key>1234abcd</api_key>
</rsp>

Response (After transition):

<rsp stat="ok" version="1.0">
  <api_key>5678qwertyuiop</api_key>
  <version>4</version>
</rsp>

Note: Using version 3 to login will continue to work, even though all other endpoints will require version 4

Request Path Changes

You will need to modify your request to use the /version/4 path. For example:

Before transition:

GET: https://pi.pardot.com/api/prospect/version/3/read/id/1

After transition:

GET: https://pi.pardot.com/api/prospect/version/4/read/id/1

Prospect API changes

Most of the changes in version 4 occur around the prospect APIs. When you begin using the version 4 APIs, your logic should know about these changes (full documentation can be found here)

Opportunity API changes

Full documentation can be found here.

Visitor API changes

Full documentation can be found here.