Blog
Token
About Us
AiDOOS Wiki
Project Cost Estimation

Welcome to Knowledge Base!

KB at your finger tips

This is one stop global knowledge base where you can learn about all the products, solutions and support features.

Categories
All
CRM
Salesforce
ERP
SAP
Storage and Backups
Purestorage Netapp Nutanix
Cloud
AWS
Computing
IBM
Database
MongoDB MySQL PostgreSQL
DevOps
Docker Kubernetes Jenkins GitLab
Mobile
React Native Android
Web
React Angular PHP
Programming
Python
Products
CNC Software (Mastercam) 3D perception 7shifts

CRM-Salesforce

Salesforce Developers

Authentication

Prerequisites:

  1. You must have Salesforce OAuth set up in the org. To set up a connected app for OAuth, the "pardot_api" scope must be one of the selected OAuth scopes. Otherwise, OAuth flows other than username/password flow can't be used with the Pardot API. Check out this video for an example of how to implement OAuth.
Implement Salesforce OAuth for Pardot API
undefined

  1. You must have the Pardot Business Unit ID that you want to authenticate with. To find the Pardot Business Unit ID, use Setup in Salesforce. From Setup, enter "Pardot Account Setup" in the Quick Find box. Your Pardot Business Unit ID begins with "0Uv" and is 18 characters long. If you can’t access the Pardot Account Setup information, ask your Salesforce Administrator to provide you with the Pardot Business Unit ID.

  2. Authenticate with a user that is SSO enabled. An SSO-enabled user is one who can log in to pi.pardot.com using "Log In with Salesforce" or who can access Pardot using the Pardot Lightning App.

Pardot Account Type Salesforce Domain Pardot Domain
Production Account login.salesforce.com pi.pardot.com
Pardot Developer Org login.salesforce.com pi.demo.pardot.com
Sandbox test.salesforce.com pi.demo.pardot.com

OAuth 2.0 Flows

There are numerous OAuth 2.0 Flow types supported. The Web Server Flow is the most commonly used. For a list of all flows, see the OAuth 2.0 Flows Help page. Read the descriptions of the flows to choose the best one for your case.

After you get the access token, you must pass it and the Pardot Business Unit ID using the Authorization and Pardot-Business-Unit-Id headers.

Sample Request

Request must be made using HTTPS.

Request Parameters

Parameter Required Description
access_token X Access token obtained from Salesforce OAuth Endpoint
business_unit_id X Pardot Business Unit ID

If a valid access token is provided with a valid business unit ID, the Pardot endpoint works as expected.

Note: The Pardot API doesn’t enforce IP address restrictions that are configured using the Salesforce option "Enforce login IP ranges on every request".

Salesforce Developers

Error Codes and Messages

Use your error code or message to troubleshoot problems with the API.

Use CTRL+F to search this page for the error code or message you recieved.

In versions 3 and 4, errors are formatted as follows:

In version 5, errors are formatted as follows:

Error Code: 1

Message : Invalid API key or user key

Problem : Either the user or API keys are incorrect, or the API key has expired.

Solution : Check the user and API keys in the request. If the user key was entered accurately, then submit a request for a new API key.

Error Code: 2

Message : Invalid action

Problem : The requested operation was not recognized by the API.

Solution : Verify that the requested operation is valid for the target object type. If that operation is allowed, then check for misspellings and other typos.

Error Code: 3

Message : Invalid prospect ID

Problem : Pardot could not find a match for the provided prospect ID.

Solution : Verify that the prospect ID is accurate.

Error Code: 4

Message : Invalid prospect email address

Problem : Pardot could not find a prospect with the provided email address (for read, update, or delete), or the prospect email address is too long (> 255 characters) or has invalid syntax (for create/upsert). See Allowed Characters in Email Addresses for email address verification.

Solution : If running create or upsert, verify the email address is valid. If running read, update, or delete, verify that a prospect with this email address exists in your Pardot account.

Error Code: 5

Message : Invalid query parameters

Problem : Pardot did not recognize any of the provided search parameters.

Solution : Check parameter spellings. Also, ensure that the specified search parameter is supported by the API. See Parameters to Select Prospects for more details.

Error Code: 6

Message : Invalid time frame

Problem : The value of the timeframe search parameter was not recognized.

Solution : Check for misspellings in the timeframe value. Also, verify that the provided value is supported by the API. See Parameters to Select Prospects for more for supported timeframe values.

Error Code: 7

Message : Invalid timestamp

Problem : Pardot could not decipher a specified timestamp.

Solution : Verify that the timestamp adheres to GNU standards for date and time input. See GNU Date Input Format & Syntax for more information. Also, ensure all characters in the timestamp are URL safe. See Parameters to Select Prospects for supported values.

Error Code: 8

Message : Invalid time range

Problem : The provided start timestamp is later than the end timestamp.

Solution : Swap the values of the timestamps.

Error Code: 9

Message : A prospect with the specified email address already exists

Problem : The provided email address is already assigned to a prospect within Pardot. This error can occur when a create request with the same email address is submitted more than once.

Solution : Check the existing prospect record to see if data can be merged through an update request.

Error Code: 10

Message : Invalid user ID

Problem : The provided user ID does not exist in Pardot.

Solution : Verify that the user ID was typed correctly and matches the intended user in Pardot.

Error Code: 11

Message : Invalid user email address

Problem : The provided user email address could not be found in Pardot.

Solution : Verify that the provided email address belongs to a registered Pardot user and that it was typed correctly.

Error Code: 12

Message : Invalid group ID

Problem : The provided group ID does not exist in Pardot.

Solution : Verify that the group ID was typed correctly and matches the intended group in Pardot.

Error Code: 13

Message : One or more required parameters are missing

Problem : One or more of the required parameters for this type of request are missing.

Solution : Verify that all of the required parameters have been provided. Check that all parameter names were spelled accurately and as specified in Object Field References. Ensure the proper URL punctuation was used, including ? before parameters and & between parameters.

Error Code: 14

Message : Non-existent prospect ID; No email address provided

Problem : The ID provided for the upsert was not valid, and no email address was provided for a new prospect to be created.

Solution : Verify the provided ID. If creating a prospect was intended, ensure that an email address was provided.

Error Code: 15

Message : Login failed

Problem : The provided email address, password, or user key is invalid.

Solution : Check the provided credentials for typos. Also, ensure that the specified user account has at least "Marketing" access privileges.

Error Code: 16

Message : Invalid ID

Problem : The provided ID is not valid.

Solution : Ensure that only valid integer values were provided.

Error Code: 17

Message : Invalid ID range

Problem : The provided ID range is not valid.

Solution : Swap the values of the specified IDs.

Error Code: 18

Message : Invalid value for profile criteria matching status

Problem : The provided value for a profile criteria's matching status was not recognized.

Solution : Ensure that only the values match , nomatch , or unknown are being used.

Error Code: 19

Message : Invalid value specified for sort_by

Problem : The provided value for the sort_by is not a supported sorting order.

Solution : Check that the specified sorting values are listed in Using (Object Type): Supported Sorting Options section for the target object.

Error Code: 20

Message : Invalid value specified for sort_order

Problem : The provided value for the sort_order is not a supported sorting order.

Solution : Ensure that only the values ascending or descending are being used.

Error Code: 21

Message : Invalid value specified for offset

Problem : The provided value for offset could not be interpreted as an integer.

Solution : Check for typos that can prevent the value from being interpreted.

Error Code: 22

Message : Unsupported feature in this version of the API

Problem : The feature requested by the API call is not implemented in this version of the API.

Solution : Update the request to use the necessary API version.

Error Code: 23

Message : Invalid value specified for limit

Problem : The provided value for limit is invalid.

Solution : Ensure that the provided value is an integer and is no larger than 200.

Error Code: 24

Message : Invalid visitor ID

Problem : The provided visitor ID does not exist in Pardot.

Solution : Verify that the visitor ID was typed correctly and matches the intended visitor in Pardot.

Error Code: 25

Message : Parameter is_starred must be true or false

Problem : The value specified for is_starred could not be interpreted as a boolean.

Solution : Verify that only the values true or false were specified.

Error Code: 26

Message : Parameter assigned must be true or false

Problem : The value specified for assigned could not be interpreted as a boolean.

Solution : Verify that only the values true or false were specified.

Error Code: 27

Message : Parameter deleted must be true or false

Problem: The value specified for deleted could not be interpreted as a boolean.

Solution: Verify that only the values true or false were specified.

Error Code: 28

Message : Parameter new must be true or false

Problem: The value specified for new could not be interpreted as a boolean.

Solution: Verify that only the values true or false were specified.

Error Code: 29

Message : Invalid value specified for score

Problem : The value specified for score could not be interpreted as an integer.

Solution : Check for typos that can prevent the value from being interpreted correctly.

Error Code: 30

Message : Invalid score range specified

Problem : The provided score range is not valid.

Solution : Swap the values of the specified scores.

Error Code: 31

Message : Invalid combination of parameters for score

Problem : A conflicting set of query criteria for the prospect's score has been specified.

Solution : Make sure that score_equal_to is not being used in combination with score_greater_than or score_less_than .

Error Code: 32

Message : Invalid value specified for grade

Problem : The value specified for grade is not one of the allowed options.

Solution : Check for typos that may prevent grade from being interpreted correctly. SeeParameters to Select Prospects for supported values. Also, ensure that the specified grades are URL-encoded.

Error Code: 33

Message : Invalid grade range specified

Problem : The provided grade range is not valid.

Solution : Swap the values of the specified grades.

Error Code: 34

Message : Invalid combination of parameters for grade

Problem : A conflicting set of query criteria for the grade has been specified.

Solution : Make sure that grade_equal_to is not being used in combination with grade_greater_than or grade_less_than .

Error Code: 35

Message : Invalid opportunity ID

Problem : Pardot could not find a match for the provided opportunity ID.

Solution : Verify that the opportunity ID is accurate.

Error Code: 36

Message : One or more required parameter values are missing

Problem : Some of the parameters necessary to complete the specified API request were omitted from the request.

Solution : Ensure that all required parameters have been included. In addition, check from typos in the parameter names. Also check that the request has been properly formatted.

Error Code: 37

Message : A Salesforce connector was detected

Problem : Your Pardot account has a Salesforce connector. When a Salesforce connector is present, opportunities and prospect account cannot be modified by Pardot.

Solution : (NOT RECOMMENDED) Deleting the Salesforce connector allows for opportunity modification to be done through the API. However, doing so disables synchronization with Salesforce. If a Salesforce connector is present, modifications to opportunities must be done within Salesforce.

Error Code: 38

Message : Invalid campaign ID

Problem : Pardot could not find a match for the provided campaign ID.

Solution : Verify that the campaign ID is accurate.

Error Code: 39

Message : Invalid profile ID

Problem : Pardot could not find a match for the provided profile ID.

Solution : Verify that the profile ID is accurate.

Error Code: 40

Message : Invalid opportunity probability

Problem : The value specified for probability is not valid.

Solution : Ensure that the specified value is a number from 0 through 100 inclusive.

Error Code: 41

Message : Invalid probability range specified

Problem : The specified probability range is not valid.

Solution : Ensure that the specified values are numbers from 0 through 100, inclusive. It might be necessary to swap the values of the specified probabilities.

Error Code: 42

Message : Invalid opportunity value

Problem : The value specified for value is not valid.

Solution : Ensure that the specified value is a non-negative number.

Error Code: 43

Message : Invalid opportunity value range specified

Problem : The specified value range is not valid.

Solution : Ensure that the specified values are non-negative numbers. It might be necessary to swap the specified values.

Error Code: 44

Message : The provided prospect_id and prospect_email parameters do not match

Problem : The specified prospect_email and prospect_id parameters do not correspond to the same prospect.

Solution : Ensure that the specified email address and the ID both correspond to the desired prospect. Note: Typically, only one of these parameters is required. Consider omitting one of them.

Error Code: 45

Message : The provided user_id and user_email parameters do not match

Problem : The specified user_id and user_email parameters do not correspond to the same user.

Solution : Ensure that the specified email address and the ID both correspond to the desired user. (Note: Typically, only one of these parameters is required. Consider omitting one of them.)

Error Code: 46

Message : This API user lacks sufficient permissions for the requested operation

Problem : The currently authenticated API user doesn't have the necessary permissions to perform the requested operation.

Solution : Some API operations are only available to users with Administrative permissions. If the requested operation has such a requirement, reauthenticate as an administrative user and resubmit the request. See the Authentication section for more information.

Error Code: 47

Message : Multiple assignment targets were specified

Problem : More than one object was specified as a target for this ASSIGN request. For example, both a group and user were specified as targets of a prospect assignment.

Solution : Ensure that only one target is specified when submitting an ASSIGN request.

Error Code: 48

Message : Invalid visit ID

Problem : The provided visit ID does not exist in Pardot.

Solution : Verify that the visit ID was typed correctly and matches the intended visit in Pardot.

Error Code: 49

Message : Access Denied

Problem : User is not authorized to perform the requested operation either due to access restrictions or forbidden method of passing credentials

Solution : Verify user has required access to perform the requested operation. Ensure that credentials are passed via a supported method as per the API documentation. Contact customer support if problem persists.

Error Code: 50

Message : Invalid boolean

Problem : Need a valid boolean value, like true.

Solution : Make sure to use lowercase.

Error Code: 51

Message : Invalid parameter

Problem : Object type is invalid.

Solution : Change the object type to one of the allowed types.

Error Code: 52

Message : Invalid parameter range

Problem : A parameter in the request is outside its acceptable range.

Solution : Update the parameter to be within the acceptable range.

Error Code: 53

Message : Client IP address/location must be activated before accessing API

Problem : IP is not in the allowed list.

Solution : Add the IP address to the allowed list to access the API.

Error Code: 54

Message : Email address is already in use

Problem : Email address is already being used by other prospect.

Solution : Use different email address.

Error Code: 55

Message : Invalid list ID

Problem : You either did not specify the list ID, or that List ID doesn't exist.

Solution : Specify an ID, or check to make sure using the correct ID.

Error Code: 56

Message : Invalid number entered for field

Problem : The value entered doesn't match the field's type of Number.

Solution : Verify that there are no characters in the value.

Error Code: 57

Message : Invalid date entered for field

Problem : The value entered doesn't match the field's type of Date, it is an invalid format.

Solution : Verify that the timestamp adheres to GNU standards for date and time input. See GNU Date Input Format & Syntax for more information. Also, ensure all characters in the timestamp are URL safe. See Supported Search Criteria in Prospects for supported values.

Error Code: 58

Message : That prospect is already a member of that list. Update the membership instead.

Problem : The prospect is a member of the list already.

Solution : Update the membership.

Error Code: 59

Message : A CRM connector was detected

Problem : Your Pardot account has a CRM connector. When a CRM connector is present, opportunities and prospect account cannot be modified by Pardot.

Solution : (NOT RECOMMENDED) Deleting the CRM connector allows for opportunity modification to be done through the API. However, doing so disables synchronization with your CRM. If a CRM connector is present, modifications to opportunities must be done within your CRM.

Error Code: 60

Message : Invalid HTTP request method

Problem : The endpoint does not support the HTTP method of the request.

Solution : Use the proper HTTP method for the endpoint. Reference object endpoint documentation or Version 5 Overview.

Error Code: 61

Message : Invalid prospect account id

Problem : Prospect Account ID was incorrect or doesn't exist.

Solution : Verify that the prospect account ID was typed correctly and matches the intended Prospect Account in Pardot.

Error Code: 62

Message : Conflicting Update

Problem : Another update is occurring at the same time.

Solution : Wait before performing this action.

Error Code: 63

Message : Too many IDs specified

Problem : There is a limit on how many IDs you can specify for this query.

Solution : Lower the number of IDs you are querying for.

Error Code: 64

Message : Email content missing required variables

Problem : The content of the email is missing required variables.

Solution : Ensure that all required variables, such as unsubscribe link, are present.

Error Code: 65

Message : Invalid email format

Problem : Doesn't have all required fields present or are not in proper format, such as from address.

Solution : Ensure all fields are present, populated, and in proper format.

Error Code: 66

Message : You have exceeded your concurrent request limit. Please wait, before trying again

Problem : Have made too many requests in this time period.

Solution : Wait a little before making more requests.

Error Code: 67

Message : You have reached or exceeded the limit of how many of this type of object you may have.

Problem : You have too many of the specified object type to create more.

Solution : Delete some of the object if you must make more.

Error Code: 68

Message : Template with this id does not exist.

Problem : The template you are trying to access does not exist.

Solution : Make sure you are using the correct template ID or create a one to use.

Error Code: 70

Message : Batch processing is limited to 50 prospects at once.

Problem : You are requesting to batch more prospects in an operation than we allow.

Solution : Ensure that your batch request has 50 or fewer prospects.

Error Code: 71

Message : Input needs to be valid JSON or XML

Problem : You've inputted invalid JSON or XML.

Solution : Ensure that your request is properly formatted.

Error Code: 72

Message : JSON has been corrupted, hash does not match

Problem : The encoded JSON has been corrupted at some point.

Solution : Ensure that you are sending the correct information.

Error Code: 73

Message : Currently there is not an Email Plug-in Campaign associated to successfully track this email. Please contact your Pardot administrator to ensure there is a proper campaign associated with the Account Settings in Pardot.

Problem : Currently there is not an Email Plug-in Campaign associated to successfully track this email.

Solution : Contact your Pardot administrator to ensure there is a proper campaign associated with the Account Settings in Pardot.

Error Code: 74

Message : The email client is not supported by the plugin API

Problem : The email client used is not supported by this API.

Solution : Use an appropriate email client.

Error Code: 75

Message : There was an error processing the request for the account variable tags

Problem : There was an error processing the request for the account variable tags.

Solution : Review the variable tags, and resubmit the request.

Error Code: 76

Message : API access was disabled

Problem : API access for your account has been disabled.

Solution : Contact customer support.

Error Code: 77

Message : Invalid prospect fid

Problem : The provided Prospect FID was invalid.

Solution : Provide a valid Prospect FID.

Error Code: 79

Message : Invalid CRM_FID

Problem : The CRM FID provided is invalid.

Solution : Provide a valid CRM FID that can be accessed by your account, or is already attached to a prospect.

Error Code: 80

Message : Invalid CRM_TYPE

Problem : The CRM type provided or used is invalid.

Solution : Specify a correct CRM type.

Error Code: 81

Message : Prospect ID and FID do not match

Problem : The provided Prospect ID and FID do not match a single prospect.

Solution : Provide a prospect ID and FID that match a single prospect.

Error Code: 83

Message : No valid CRM connectors available

Problem : Your account does not have an available CRM connector.

Solution : Add a CRM connector to your account.

Error Code: 84

An error has occurred for which no reason is provided.

Error Code: 85

Message : Unable to save the prospect

Problem : For some reason, the prospect was not saved.

Solution : Resubmit the request or review the original request for errors.

Error Code: 86

Message : Invalid Template id

Problem : The template ID provided does not correspond to a template.

Solution : Provide a template ID that is valid.

Error Code: 88

Message : Your account must use version 4 of the API.

Problem : You have requested version 3 of the API, but your account must use version 4.

Solution : Make the request using /version/4 in place of /version/3 .

Error Code: 89

Message : Your account is unable to use version 4 of the API.

Problem : You have requested version 4 of the API, but your account must use version 3.

Solution : Make the request using /version/3 in place of /version/4 .

Error Code: 90

Message : Prospect array should be a flat array of attributes

Problem : The prospect array given was not a flat array, and it should have been.

Solution : Resubmit the request with a flat array. See the Prospect Batch sections of the Prospect object documentation for examples.

Error Code: 91

Message : Prospect array must be keyed by email address

Problem : The prospect array given was not keyed by email addresses, but should have been.

Solution : Resubmit the request with an array keyed by email addresses. See the Prospect Batch sections of the Prospect object documentation for examples.

Error Code: 92

Message : Prospect record could not be found

Problem : The prospect record was not found with the provided information.

Solution : Resubmit the request with different parameters.

Error Code: 93

Message : The selected template is missing send options

Problem : Send options are required for the template.

Solution : Resubmit the request with send options.

Error Code: 94

Message : The provided version is not a valid number

Problem : The version number used is not valid.

Solution : Resubmit the request with a valid version number.

Error Code: 95

Message : Folder name is invalid

Problem : The name for the folder is not valid.

Solution : Resubmit the request with a valid folder name.

Error Code: 96

Message : User does not have access to this folder

Problem : The role assigned for this user does not have access to this folder.

Solution : Update the users permissions and resubmit the request.

Error Code: 97

Message : The folder ID provided does not exist

Problem : No folder was found for the ID provided.

Solution : Resubmit the request with a different folder ID.

Error Code: 98

Message : Prospect not mailable

Problem : One or more of the recipient prospects cannot receive the email requested (due to opting out, being flagged as "Do Not Email", or for other reasons)

Solution : Check that the recipient list is correct, and that the prospect's email preferences are up to date.

Error Code: 99

Message : User with the provided email already exists

Problem : A user with the email provided is already in the system.

Solution : Resubmit the request with a different email address.

Error Code: 100

Message : The provided time zone is invalid

Problem : The value provided does not match a valid time zone.

Solution : Resubmit the request with a different time zone.

Error Code: 101

Message : The provided role is invalid

Problem : The value provided for role is not valid.

Solution : Resubmit the request with a different role.

Error Code: 102

Message : The CRM Username specified is currently applied to another user

Problem : This CRM username is already in use and cannot be used for another user.

Solution : Resubmit the request with a different CRM username to apply for the user.

Error Code: 103

Message : A CRM connector was not detected

Problem : A CRM connector was not found.

Solution : Make sure to configure a valid CRM connector and try again.

Error Code: 104

Message : The CRM Username specified was not detected

Problem : The CRM username was not found.

Solution : Verify the CRM username provided is correct and try again.

Error Code: 105

Message : There is no activation hash for the specified user

Problem : The activation hash for the provided user was not found.

Error Code: 106

Message : User is already active

Problem : The user is already activate.

Error Code: 107

Message : Password does not meet requirements

Problem : The submitted password does not meet the password requirements.

Solution : Resubmit the request using a password that meets the requirements.

Error Code: 108

Message : This Asset cannot be deleted because it is being used in other places.

Problem : Unable to delete an asset if it is used in other places.

Solution : Remove all dependencies of this asset and try again.

Error Code: 109

Message : The requested record was not found.

Problem : Unable to find the requested resource.

Solution : Verify the parameters are correct and resubmit the request.

Error Code: 110

Message : Invalid Account Id

Problem : Invalid account id submitted.

Solution : Verify the account id is correct and resubmit the request.

Error Code: 111

Message : The Integration Username specified is currently applied to another Account

Problem : Unable to use the submitted username as it is already used.

Solution : Resubmit the request using a different integration username.

Error Code: 112

Message : Missing recipient to Track With Engage.

Problem : The recipient parameter is missing.

Solution : Resubmit the request with a valid recipient.

Error Code: 113

Message : Missing CRM ID or Email Address of recipient.

Problem : The request is missing required information.

Solution : Resubmit the request with a valid CRM ID or email address.

Error Code: 114

Message : Invalid CRM ID or Email Address of recipient.

Problem : The CRM ID or email address is invalid.

Solution : Resubmit the request with a valid CRM ID or email address.

Error Code: 115

Message : Number of recipients is more than threshold.

Problem : The number of recipients provided is too large.

Solution : Resubmit the request with fewer recipients.

Error Code: 116

Message : Request outdated.

Problem : The request time has expired.

Solution : Resubmit the request.

Error Code: 117

Message : There was an error deleting the micro campaign.

Problem : There was an error deleting the micro campaign.

Error Code: 118

Message : This API can only be called in a test environment.

Problem : This endpoint can only be called in a test environment.

Error Code: 119

Message : Unable to create refresh tokens for Salesforce connector

Problem : Unable to create a refresh token for the Salesforce connector for authentication.

Solution : Resubmit the request to try again. If the problem persists, contact support.

Error Code: 120

Message : Unable to verify Salesforce connector

Problem : Unable to verify the Salesforce connector.

Solution : Resubmit the request to try again. If the problem persists, contact support.

Error Code: 121

Message : Unable to sync Prospect with Salesforce

Problem : Unable to sync prospects with Salesforce.

Solution : Resubmit the request to try again. If the problem persists, contact support.

Error Code: 122

Message : Daily API rate limit met

Problem : The daily allowed API requests have been met.

Solution : Wait until the next calendar day for the daily limit to reset and try again.

Error Code: 123

Message : Unable to verify Salesforce username; User may already have a verified Salesforce username.

Problem : Unable to verify Salesforce username.

Solution : Verify if the username has already been verified in the system.

Error Code: 124

Message : Unable to set Salesforce username or id

Problem : Unable to set the Salesforce username or id.

Solution : Verify the Salesforce username or ID is correct and resubmit the request.

Error Code: 125

Message : Cannot accept both user_id and crm_owner_fid.

Problem : This request only accepts a user_id or crm_owner_fid but not both.

Solution : Resubmit the request passing only a user_id or crm_owner_fid.

Error Code: 126

Message : Invalid authentication mechanism

Problem : This authentication method has been deprecated.

Solution : Resubmit the request using a valid authentication method.

Error Code: 128

Message : Cannot create campaigns

Problem : Campaigns cannot be created for an account that has Connected Campaigns enabled.

Solution : Create a campaign in Salesforce.

Error Code: 129

Message : Cannot modify campaign name or cost

Problem : Campaign name and cost can't be modified via the API.

Solution : Remove the name and cost fields from the request.

Error Code: 130

Message : One or more of the specified fields are invalid

Problem : One or more of the fields in the CSV is not a recognized standard or custom field.

Solution : Ensure all of the column headers in the CSV match the headers in the field reference. Ensure the number of columns in the CSV matches the number of columns in the header row.

Error Code: 131

Message : Your account is locked due to too many failed login attempts. Reset your password at https://pi.pardot.com/user/passwordReset

Problem : Too many invalid api requests have been made.

Solution : Reset your password at https://pi.pardot.com/user/passwordReset

Error Code: 132

Message : Prospect is archived

Problem : The prospect is in the recycle bin and can't be read.

Solution : Undelete the prospect via the UI or choose another prospect.

Error Code: 133

Message : Up to 2 sort by options are allowed.

Problem : Too many columns were passed into the sort parameter.

Solution : Use 2 or fewer sort by columns.

Error Code: 134

Message : Up to 2 sort order options are allowed.

Problem : Too many orders were passed into the sort parameter.

Solution : Use 2 or fewer sort orders.

Error Code: 135

Message : When passing a comma-separated value, one of the two values must be id.

Problem : When sorting by multiple columns, one column must be the ID column.

Solution : Add the ID column to the request.

Error Code: 137

Message : URL is not valid. Please include a protocol (e.g., http:// or https:// )

Problem : An invalid URL was supplied in the request.

Solution : Add one of the requested protocols to the request.

Error Code: 138

Message : Name must be 50 characters or less.

Problem : The name supplied was too long.

Solution : Reduce the length of the name field.

Error Code: 139

Message : The supplied name is not valid.

Problem : The name field has an invalid character.

Solution : Remove special characters from the name field.

Error Code: 145

Message : Invalid archived parameter specified. Allowed values are true or false.

Problem : The archived parameter only accepts boolean values.

Solution : Update the request to send the proper boolean value.

Error Code: 146

Message : Invalid archived parameter specified. Allowed values are true or false.

Problem : The archived parameter only accepts boolean values.

Solution : Update the request to send the proper boolean value.

Error Code: 150

Message : Input needs to be valid JSON

Problem : The JSON that was submitted was invalid.

Solution : Submit valid JSON. A JSON linter may help ensure that the payload is valid before sending.

Error Code: 151

Message : Unsupported content-type

Problem : The 'Content-Type' header has an unsupported value for this endpoint.

Solution : Check the documentation for the specific endpoint and ensure you are sending the correct Content Type value.

Error Code: 152

Message : Request body can't be empty

Problem : The API request has no body.

Solution : Ensure that the payload of the request is being sent and is encoded as 'application/json'

Error Code: 153

Message : Missing required property in request

Problem : A required field in the request body could not be found.

Solution : Check the documentation and ensure that all required fields in the request body are specified.

Error Code: 154

Message : Invalid property in request

Problem : A field in the request body has an invalid value.

Solution : Check the documentation and ensure that the value that is being passed is supported. Several values are not supported at this time.

Error Code: 155

Message : Can't update. Import must be in "Open" state.

Problem : The import that is trying to be updated is not in the “Open” state.

Solution : This import is no longer eligible to receive updates. Create an import, or update an existing import in the “Open” state.

Error Code: 156

Message : Can't start processing. Import has no associated data.

Problem : The import that is trying to be set to “Ready” has no data associated with it.

Solution : Upload a batch of data before setting the import to “Ready”.

Error Code: 157

Message : Error processing import request. Please contact your Pardot support representative

Problem : The import has no background processing agent associated with it.

Solution : This import was improperly created and is unsalvageable. Create an import and upload the same batch of data to ensure processing occurs.

Error Code: 158

Message : Uploading a file was unsuccessful

Problem : The “files” element of the request body could not be found.

Solution : Ensure that the CSV being uploaded belongs to a key named “files”.

Error Code: 159

Message : The file is not in a valid CSV format

Problem : The CSV file is invalid.

Solution : Ensure that the CSV file is properly formatted. There must be 1 header row, at least 1 data row, and the number of columns in each row must match the number of columns in the header.

Error Code: 160

Message : The limit of batches per import has been reached

Problem : Too many batches have been submitted for this import

Solution : Create an import to submit this batch, or submit this batch to an import that has batch capacity.

Error Code: 161

Message : The current state of the import does not allow the operation

Problem : A batch was submitted to an import that is not “Open”

Solution : Create an import to submit this batch, or submit this batch to an import that is “Open”. Processing is not affected for the import associated with the failed request.

Error Code: 162

Message : No file was specified or uploaded

Problem : No CSV file was submitted

Solution : Submit a CSV file in the body of the request under the “files” key.

Error Code: 163

Message : Too many files were specified or uploaded

Problem : Problem: More than 1 file was submitted in a single request

Solution : Submit only 1 file per request.

Error Code: 164

Message : Daily limit of import batches has been reached

Problem : Too many batches have been submitted over a 24-hour period. The account limit has been reached.

Solution : Wait and try again later.

Error Code: 165

Message : column options is invalid

Problem : API input was incorrectly formatted.

Solution : See documentation for correct input formatting.

Error Code: 166

Message : The input is not in the required format

Problem : The request input was not specified according to the documentation.

Solution : Check the documentation for the desired endpoint and ensure the request is formatted properly.

Error Code: 174

Message : Unknown procedure name.

Problem : The provided procedure name does not exist.

Solution : Check procedure name is spelled correctly or try another procedure name.

Error Code: 175

Message : Unknown procedure argument.

Problem : An unsupported argument was included in the procedure arguments.

Solution : Check arguments are spelled correctly or remove unsupported argument.

Error Code: 176

Message : Missing required argument.

Problem : The export procedure is missing a requirement argument.

Solution : Include the required argument in your procedure definition.

Error Code: 177

Message : Invalid procedure argument.

Problem : An invalid value has been provided for a procedure argument.

Solution : Check the values provided for the procedure arguments are correct.

Error Code: 178

Message : The current state of the export does not allow the operation

Problem : The operation is not possible because of the state of the export. Possible reasons are that the export is expired or is still running.

Solution : If the export has not completed, wait until the read endpoint indicates that the export is complete before retrying the operation.

Error Code: 180

Message : One or more of the specified fields are invalid

Problem : One or more of the fields included in a create or update operation are not valid for that operation.

Solution : Only include fields that are writable in the operation.

Error Code: 181

Message : A required header is missing

Problem : A required HTTP header is missing on the request. For example, if using Salesforce access tokens for authentication, the Pardot-Business-Unit-Id header must be included.

Solution : Include the required header.

Error Code: 182

Message : Invalid header value

Problem : The value included in an HTTP header is not valid. It may be formatted incorrectly.

Solution : Check documentation for the header.

Error Code: 183

Message : An internal error occurred, please try your request again

Problem : An internal error occurred.

Solution : Try the request again. The error may have been related to a temporary condition such as a request failure between internal Pardot or Salesforce systems.

Error Code: 184

Message : access_token is invalid, unknown, or malformed

Problem : The access token passed in the Authorization header is not usable to make API requests to Pardot.

Solution : Make sure the access token is formatted correctly and was obtained using a Connected App that includes the pardot_api OAuth scope. Make sure the user associated with the token is synced to the Pardot business unit. Make sure the token used is within its expiration time.

Error Code: 188

Message : Provided import origin is invalid

Problem : The import origin specified is not valid.

Solution : Use "ui", "api", or "all" for the import origin.

Error Code: 190

Message : Email sending is blocked for this account.

Problem : The account has email sending blocked, and an email is being sent.

Solution : Contact support.

Error Code: 192

Message : Object specified does not exist

Problem : The object ID specified in the API request does not correspond to an object that exists. The object may have been deleted or the object ID passed in may never have been valid.

Solution : Pass in a valid ID for an object that is not deleted or change the request to request a deleted object (one that is in the Pardot recycle bin). Use the deleted=true parameter in v5.

Error Code: 193

Description : Too many subfields have been requested for one of the fields in the fields URL parameter for the API call. Pardot limits the number of fields that can be traversed when constructing an API response.

Error Code: 194

Message : Invalid MIME type.

Problem : The uploaded file is not of an allowed type.

Solution : Upload a file of an allowed type. Make sure the extension of the file is appropriate for its type.

Error Code: 199

Message : Authentication using an api_key is no longer supported. Use Salesforce OAuth access token instead. See https://developer.pardot.com/kb/authentication/ for details.

Problem : The Pardot API doesn't support api_key based authentication.

Solution : Salesforce OAuth endpoints should be used to retrieve an access token. See Authentication for details

Error Code: 201

Message : Business Unit specified in Pardot-Business-Unit-Id header not found or inactive.

Problem : The Business Unit ID is invalid or the business unit isn't active. This error is also returned when you use the wrong hostname (pi.pardot.com or pi.demo.pardot.com).

Solution : Make sure that you're using a valid Business Unit ID for an active business unit, and that your URL contains the correct hostname.

Error Code: 203

Message : An admin user for the account not found. Ensure a user with the default admin role exists.

Problem : There are no users with the default admin role.

Solution : Make sure there is at least 1 user with the default admin role in Pardot.

Error Code: 204

Message : File size exceeds the max post size or the body message can't be empty

Problem : The file attached is larger than 50MB or has 0 bytes.

Solution : Make sure the content of the file does not exceed 50MB

Error Code: 205

Message : Action name is either missing or incorrect

Problem : The requested object doesn't support the requested record action.

Solution : Check spelling and verify that the record action is available for the requested object.

Error Code: 206

Message : Invalid action argument value

Problem : The supplied value for the argument is not of the required data type.

Solution : Make sure that the arguments are of the required data type according to the documentation. Strings must be enclosed by double quotes (").

Error Code: 207

Message : Missing required action argument

Problem : One or more of the required arguments are missing.

Solution : Make sure that you provide all of the required arguments for the requested record action.

Error Code: 208

Message : Unknown action argument

Problem : The supplied arguments to the record action are misspelled or invalid.

Solution : Make sure that the arguments are spelled correctly and that they correspond to the arguments supported by the record action, according to the documentation.

Error Code: 209

Message : Too many fields have filters: The max number of 3 distinct fields with filters was exceeded for this query.

Problem : Too many fields in the request have filters. You can add filters to up to 3 fields.

Solution : Decrease the number of fields with filters in the request.

Error Code: 210

Message : Page token has expired.

Problem : The page token is expired. Tokens are valid for 4 hours.

Solution : Make sure you aren't using a page token that was issued more than 4 hours ago.

Error Code: 211

Message : Page token is invalid.

Problem : The token is null or invalid.

Solution : Make sure the page token sent corresponds to the one provided by the last call's response.

Error Code: 214

Message : API request timed out.

Problem : The request timed out.

Solution : Retry the query with smaller limits, offsets, or filter ranges.

Error Code: 215

Message : Feature state is invalid: Connected Campaigns is not enabled for this account.

Problem : Connected Campaigns is not enabled for the Pardot account or business unit.

Solution : Enable Connected Campaigns.

Error Code: 216

Message : Destination folder is full.

Problem : The target folder for the object is full, and the object can't be created.

Solution : Choose a different folder, or remove assets from the target folder.

Error Code: 217

Message : Visitor is invalid.

Problem : The visitor is invalid because is_identified is false or null on the visitor record, or ipAddress is null on the visitor record.

Solution : Check the visitor ID or fix the is_identified or ipAddress fields on the visitor record.

Error Code: 10000

Problem : An error occurred when processing the parameter designated in the param attribute of the <err> node. Several <err> nodes may be contained within the ``` ` node if multiple errors occurred.

Solution : The msg attribute of each <err> node should contain advice as to how to remedy the error.

Read article

Salesforce Developers

Version 3 and 4 Overview

The Pardot API lets your application access current data within Pardot. Through the API, you can perform several common operations on Pardot objects including the following:

  • create -- Creates an object with the specified parameters.
  • read -- Retrieves information about the specified object.
  • query -- Retrieves objects that match specified criteria.
  • update -- Updates elements of an existing object.
  • upsert -- Updates elements of an existing object if it exists. If the object does not exist, one is created using the supplied parameters.

You must authenticate using a Salesforce OAuth endpoint. See Authentication for more.

Keep a few considerations in mind when you perform requests. For update requests, only the fields specified in the request are updated. All others are left unchanged. If a required field is cleared during an update , the request is declined.

All requests to the API:

  • Must use either HTTP GET or POST
  • Must pass the access token.
  • Must pass Pardot Business Unit ID in an HTTP Pardot-Business-Unit-Id header (obtained using Salesforce OAuth) to authenticate.
  • Must use the correct URL for your Pardot environment. See Test and Production Environments.

These examples use a production environment, so the domain is pi.pardot.com . If you are using a test environment, your domain is pi.demo.pardot.com . See Test and Production Environments.

Request Parameters

Parameter Required Description
object X The object type to be returned by the API request
op X The operation to be performed on the specified object type
id_field X The field to be used as the identifier for the specified object
id X The identifier for the specified objects
access_token X The access token obtained during Authentication
pardot_business_unit_id X The Pardot business unit. For details see Authentication
format The API data format: either xml (default) or json
params Parameters specific to your request; See individual methods for details

The ordering of parameters is arbitrary. Parameters are passed using conventional HTML parameter syntax, with '?' indicating the start of the parameter string (for GET requests only) and '&' as the separator between parameters. With the exception of <format> and <params> , all components are required. Data returned from the API is formatted using JSON or XML 1.0 with UTF-8 character encoding. Keep in mind that some characters in the response can be encoded as HTML entities, requiring client-side decoding. Also, keep in mind that all parameters specified in an API request MUST be URL-encoded before they are submitted.

In general, the API returns XML or JSON containing a current version of the target object's data. But unsuccessful requests return a short response containing an error code and message. See Error Codes & Messages for error descriptions and suggested remedies: Error Codes and Messages

The Pardot API supports several output formats, and each returns different levels of detail in the XML or JSON response. Output formats are defined by specifying the output request parameter. Supported output formats include:

  • full -- Returns all supported data for the Pardot object and all objects associated with it.
  • simple -- Returns all supported data for the Pardot object.
  • mobile -- Returns an abbreviated version of the object data. This output format is ideal for mobile applications.
  • bulk -- Returns basic data for an object (does not provide total object count). Used for querying large amounts of data.

If the output request parameter is not defined, the output format defaults to full . See the XML Response Format sections for each object for details about the formats.

Here's an example of calling the Pardot API using a simple PHP client using the cURL library.

Note: We strongly recommend against using PHP's file_get_contents function to call the Pardot API because it makes error handling cumbersome.

Read article

Salesforce Developers

Transitioned from Version 3 to Version 4?

Version 4 was created to accommodate multiple prospects with the same email address. If your Pardot org has the allow multiple prospects with the same email address (AMPSEA) feature enabled, then use version 4. If your Pardot org doesn’t have AMPSEA enabled, use version 3.

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

If you want to enable AMPSEA in your Pardot account, use the following guidelines to keep using Pardot APIs.

Update your requests to use the /version/4 path. For example:

Before:

After:

Most of the differences between version 3 and version 4 are in the prospect APIs.

  • New reference field: Prospects can be referenced using the Salesforce CRM Identifier, the fid field. This fid field refers to the ID of the Lead or Contact record in Salesforce. You can find the lead ID (begins with 00Q) or the contact ID (begins with 003) in the URL when viewing a lead or contact record. Or, you can get multiple contacts or lead ID from Salesforce using the export tool. lead_identifier_example
  • Create: Prospects can still be created with a referenced email address. If you call the create API with the same email address multiple times, each call creates a prospect. Previously, you would get an error.
  • Read: When making a read query, querying by email returns all prospects that share that email address. Querying by Pardot id or Salesforce fid only returns the one matching prospect.
  • Update: Because there can be multiple prospects with the same email address, prospects can no longer be updated when referenced via email alone. Instead, use either the Pardot id or Salesforce fid references.
  • Upsert: Upsert query by email always creates a prospect. Upsert by Pardot id or Salesforce fid updates or creates as needed. See Upserting Prospects for more details.
  • Delete: Delete query must reference by Pardot id or Salesforce fid .
  • Batch processing: See examples of batch processing in the Prospect object documentation.

See the Prospect object documentation.

  • Create: Creating an opportunity using a prospect_email reference must correspond to an existing prospect. If there are multiple prospects with that email address, the prospect with the most recent activity date is used. If you want to apply the opportunity to a specific prospect, then reference the prospect using prospect_id .
  • Query: If you query using a prospect_email reference, you receive opportunities that correspond with any prospects that share that email address. if you want a specific prospect then query by the prospect_id .

See the Opportunity Object documentation.

  • Assign: Assigning by prospect_email alone (no prospect_id ) returns an error.

See the Visitor Object documentation.

Read article

Salesforce Developers

Bulk Data Pull via the Pardot API

This document outlines the approach and best practices for pulling large amounts of data out of Pardot via the API.

When you need large amounts of visitor activity data, use the Export API. If you need a different object, see Query the Pardot API for details on how to retrieve the information using the query endpoint.

The Export API is asynchronous and efficiently scales data retrieval based on the available resources. There are more server resources available for the Export API than the query endpoint, which provides faster results without hitting concurrency and API limits to process multiple queries.

Before getting started, review the documentation for the Export API.

Best Practice #1 - Polling for Status Updates

Because export is asynchronous, you can poll the Read endpoint of the Export API to see if the export is done processing. The time an export takes depends on how much data is being exported and the resources available for processing. Because export times can vary, we recommend that you start by setting a polling interval between 30 seconds and a few minutes.

If you run an integration regularly, set your polling intervals to the average of the time taken for a few runs of your integration. For example, if your integration runs daily and retrieves all visitor activity data for the previous day, start with a polling frequency of 1 minute. Note the export durations for a few days, then average those times to find a polling interval. In the example, over a few days you notice that your export finishes with an average duration of 15 minutes. Polling every minute is too often and polls 15 times. If you set the polling interval to 5 minutes, it polls three or four times.

If you run integrations sporadically or infrequently, try increasing the polling interval over time. For example, if you track the number of times the integration has polled, you can calculate a gradually increasing polling interval using this function:

Where n is the index of the poll, starting with 0

Using this function to calculate polling interval, you poll a minute the first time, 2 minutes for the second and continue to increase at larger intervals each time. This process allows the integration to check frequently soon after an export is created to catch the quick running exports but also limit the number of polls for exports that are long-running.

Remember that the Read endpoint of the Export API counts toward API limits, so these tips let you adjust how much of that limit is used by your integration.

Best Practice #2 - Specify Limited Date Ranges

Because the results of the export API are returned only after the query has executed, limiting the date range of the export returns results faster. A way limit date range is to break large date ranges into several smaller ranges.

For example, it's OK to create an export to retrieve a year's worth of visitor activity within a single export by specifying a year duration, like the following.

The issue is that all 12 months of data must be queried in order for the results to be returned. There are cases where your integration can use a smaller data set up front and be refined later as more data from the export becomes available. For example, an integration can work off the last month of data while waiting on a three-month range and then increasing to a twelve-month range.

In this example, you could create three different exports with the three different ranges:

Last month

Three months prior

Eight months prior

Instead of waiting for all twelve months of data to be exported at once, the same data is returned in smaller increments, so you can see the newest data sooner.

Pulling data from a query endpoint in the Pardot API is a straightforward, two-step process. First, log in with your Pardot user email, password, and user key to acquire an API key. Then, use the query endpoint for each data set to pull the data.

Before getting started, review the object documentation and determine which data set you are going to pull. For a data set to be eligible for a bulk data pull, it must have a query operation that supports at least one of the following three sets of search filter criteria parameters:

  • created_before and created_after
  • updated_before and updated_after
  • id_greater_than and id_less_than

Issue an HTTP GET to the appropriate query endpoint to pull the data back. The query response contains up to 200 rows from the data set you have requested.

Best Practice #1 ‐ Use the Bulk Output Format

For bulk data pulls, we strongly recommended that you use the bulk output format, which is highly optimized for performance. The bulk output format disables functionality that displays additional data in the API response such as nested object relationships (for example, campaign name for activities). Additionally, the bulk output format omits information about the total number of rows that matched your query, which enables the API to return a response more quickly.

Best Practice #2 ‐ Avoid Offset

For bulk data pulls, we strongly discourage use of the offset parameter. Instead, iterate through the data set using one of the supported search filter criteria parameters.

As you process the query results in your code, store a high water mark value like the largest id or most recent created_at or updated_at value. Then, on your next query, send that high water mark value as the id_greater_than , created_after , or updated_after search filter parameter value.

Bulk API Request & Response Samples

Example Request & Response (XML)

Example Request & Response (JSON)

Because using the offset parameter is discouraged, let’s see how you can use a high water mark value to iterate through multiple pages of results instead. In this example, you query for all visitor activities that occurred yesterday. The created_after and created_before search filter criteria parameters are perfect for this use case.

To keep things simple, assume there were a total of 5 activities created yesterday (at time of writing, 2016-03-29) at times 02:00, 06:00, 10:00, 14:00, and 18:00. Also assume the API page size limit is 2 rather than 200.

To iterate over the results in the suggested approach, your API integration process would proceed as follows:

  1. Log in to the Pardot API
  2. Pull all visitor activity created after yesterday at midnight ( 2016-03-29T00:00:00 ) and before tonight at midnight ( 2016-03-30T00:00:00 ):

Example Request & Response (JSON)

Note : The example was edited for brevity.

  1. The API has returned two results - the activities from 02:00 and 06:00. Since you are paging by created_at , set your high water mark value to the created_at value of the last record you pull back, 2016-03-30T06:00:00 . You have now retrieved all activities up to that time.
  2. Pull all visitor activity created after your high water mark ( 2016-03-29T06:00:00 ) and before tonight at midnight ( 2016-03-30T00:00:00 ):

Example Request & Response (JSON)

Note : The example was edited for brevity.

  1. The API returns two more results back - the activities from 10:00 and 14:00. Since you are paging by created_at , update your high water mark value to the created_at value of the last record you pull back, 2021-03-29T14:00:00 . You have now retrieved all activities up to that time.
  2. Pull all visitor activity created after your high water mark ( 2021-03-29T14:00:00 ) and before tonight at midnight ( 2021-03-30T00:00:00 ):

Example Request & Response (JSON)

Note : The example was edited for brevity.

  1. The API returns one result back, the activity from 18:00. As the max page size is 2 and the API returned one record, you know you are at the end of the list of records and do not need to query any further. If the API had returned 2 records you would repeat the query process again with a new high water mark. You know it’s safe to stop when the number of records returned by the API is less than the max page size.
Read article

Salesforce Developers

Object Field References

  • Requests create , update , and upsert manipulate fields marked as 'Editable'.
  • 'Required' means that the specified field can't be left without a value during insert and some upsert requests. Pardot declines any update request that clears a required field.
  • During update requests, unless otherwise specified the parameter names submitted to the API and tag names in the API's response match field names within the Pardot user interface.
Field Name Data Type Required Editable Description
<id> integer Pardot ID for this account.
<level> string The level of product for the account.
<website> string Account website.
<vanity_domain> string Custom vanity domain name.
<plugin_campaign_id> integer Plugin ID for account campaign.
<tracking_code_template> string Markup and code for use in tracking templates.
<address1> string Account contact address, line 1.
<address2> string Account contact address, line 2.
<city> string Account contact city.
<state> string Account contact state.
<territory> string Account contact territory.
<zip> integer Account contact ZIP code.
<country> string Account contact country (full string).
<phone> string Account contact phone number.
<fax> string Account contact fax number.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this campaign.
<name> string X Campaign's name.
<cost> integer X Cost related to the campaign.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this custom field.
<name> string X Custom field's name.
<field_id> string API ID for custom field
<type> string X Type of field.
<type_id> integer Pardot ID for custom field's type.
<created_at> timestamp Time custom field is created in Pardot. Time is reported in API user's preferred timezone.
<updated_at> timestamp Last time custom field was updated. Time is reported in API user's preferred timezone.
<is_record_multiple_responses> boolean X If true, this custom field records multiple responses.
<crm_id> string X The CRM ID of the field you want to map to this custom field.
<is_use_values> boolean X If true, this custom field uses predefined values.
<is_analytics_synced> boolean If true, this custom field is marked to sync with Tableau CRM.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this custom redirect.
<name> string Custom redirect's name.
<Url> string URL for the custom redirect.
<destination> string URL the custom redirect leads to
<campaign> string The campaign associated with this custom redirect.
<created_at> timestamp Time custom redirect is created in Pardot. Time is reported in API user's preferred timezone.
<updated_at> timestamp Last time custom redirect was updated. Time is reported in API user's preferred timezone.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this dynamic content.
<name> string Dynamic content's name.
<embedCode> string Code to embed this dynamic content onto your webpage.
<embedUrl> string URL to embed this dynamic content.
<baseContent> string The default dynamic content.
<basedOn> string Field that this dynamic content is based on.
<variation> node The variation of content that the prospect sees based on the field's value. Note: Information about a variation is returned in a <variation> node in the XML response. It contains the value of the field in the <comparison> tag and the content of the variation in the <content> tag.
<created_at> timestamp Time dynamic content is created in Pardot. Time is reported in API user's preferred timezone.
<updated_at> timestamp Last time dynamic content was updated. Time is reported in API user's preferred timezone.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this email.
<name> string Name of this email.
<subject> string Email subject.
<message> XML Object Contains text and html elements of different formats.
<created_at> Timestamp Time the email is created.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this email click.
<prospect_id> integer Pardot ID for the associated prospect.
<url> string URL of the email click.
<list_email_id> integer Pardot ID for the associated list email. Value not present if null.
<drip_program_action_id> integer Pardot ID for the associated drip program action. Value not present if null.
<email_template_id> integer Pardot ID for the associated email template. Value not present if null.
<tracker_redirect_id> integer Pardot ID for the associated tracker redirect. Value not present if null.
<created_at> timestamp Time that email click occurs. Time is reported in API user's preferred timezone.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this form.
<name> string Form's name.
<campaign_id> string Pardot ID of the campaign associated with this form.
<embed_code> string The code used to embed the form on your webpage.
<created_at> timestamp Time form is created in Pardot. Time is reported in API user's preferred timezone.
<updated_at> timestamp Last time form was updated. Time is reported in API user's preferred timezone.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this identified company.
<name> string Identified Company's name.
<street_address> string Identified Company's street address.
<city> string Identified Company's city.
<state> string Identified Company's state.
<postal_code> string Identified Company's postal code.
<country> string Identified Company's country.
<email> string Identified Company's email address.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID of this lifecycle history.
<prospect_id> integer Pardot's ID for the prospect in this stage.
<previous_stage_id> integer Pardot ID of the stage this prospect previously was in.
<next_stage_id> integer Pardot ID of the stage this prospect is in next.
<seconds_elapsed> integer Number of seconds for prospect to get to current stage.
<created_at> timestamp Time lifecycle history is created in Pardot. Time is reported in API user's preferred timezone.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID of this lifecycle stage.
<name> string Lifecycle stage's name.
<position> integer Lifecycle stage's position in lifecycle.
<is_locked> boolean If true, lifecycle stage is locked.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID of this list.
<name> string X List's name (internal to Pardot).
<is_public> boolean X If true, list shows on EPC pages to prospects.
<is_dynamic> boolean If true, list has prospects dynamically added to it via a set of chosen rules.
<title> string X List's title (visible to subscribers)
<description> string X List's description.
<is_crm_visible> boolean X If true, list is visible in CRM, and can be added to, or removed from.
<created_at> timestamp Time list is created in Pardot. Time is reported in API user's preferred timezone.
<updated_at> timestamp Last time list was updated. Time is reported in API user's preferred timezone.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this list membership.
<list_id> integer X Pardot ID of the list for this membership.
<prospect_id> integer X Pardot ID of the prospect for this membership.
<opted_out> integer X If value is 1, the prospect is unsubscribed from receiving emails from this list.
<created_at> timestamp Time that this membership is created in Pardot. Time is reported in API user's preferred timezone.
<updated_at> timestamp Last time that this membership was updated. Time is reported in API user's preferred timezone.

Additional prospect fields available for Export

When using the v3 Export API or v4 Export API to export list membership, the following fields are selectable for export in addition to the list membership fields listed above.
Note : The following fields are only available via the Export API and are only exported if selected via fields parameter specified in export create request.

Field Name Data Type Description
<created_by> integer Pardot ID for the user who created this object.
<updated_by> integer Pardot ID for the user who last updated this object.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this opportunity.
<campaign_id> integer X X Pardot ID of the campaign associated with this opportunity.
Note : Information about an opportunity's campaign association is returned in a <campaign> node in the XML response. However, updates to campaign associations are made by providing campaign_id= <campaign_id> during an <UPDATE> request. See XML Response in the Campaign documentation for more details.
<name> string X X Opportunity's name
<value> float X X Opportunity's value.
Restrictions : The value must be a positive numeric value.
<probability> integer X X Opportunity's probability.
Restrictions : The value must be a positive integer from 0 through 100, inclusive.
<type> string X Opportunity's type.
<stage> string X Opportunity's stage.
<status> string X Opportunity's status.
Restrictions : status must be either won, lost, or open.
<closed_at> timestamp X Opportunity's closed date.
Note If this field is left blank, the closed_at timestamp (Closed Date within the app) is not set, even when the Opportunity's stage, status, or probability are set to indicate opportunity closure.
<created_at> timestamp Time opportunity is created in Pardot. Time is reported in API user's preferred timezone.
<updated_at> timestamp Last time opportunity was updated in Pardot. Time is reported in the API user's preferred timezone.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this profile.
<name> string Profile's name.
Field Name Data Type Required Editable Description
<id> integer X Required. Pardot ID for this profile criteria.
<name> string Profile criteria's name.
<matches> string X The matching status of this profile criteria with the current prospect.
Restrictions: Updates can be performed by using the values match , nomatch , or unknown .
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this prospect.
<campaign_id> integer X Pardot ID of the campaign associated with this prospect
Note : Information about a prospect's campaign association is returned in a <campaign> node in the XML response. However, updates to campaign associations are made by providing campaign_id= <campaign_id> during an <UPDATE> request. See XML Response Formats in Prospects for more details.
<salutation> string X Prospect's formal prefix.
<first_name> string X Prospect's first name.
<last_name> string X Prospect's last name.
<email> string X X Prospect's email address.
<password> string X Prospect's password.
<company> string X Prospect's company.
<prospect_account_id> integer X Prospect's account ID.
<website> string X Prospect's website URL.
<job_title> string X Prospect's job title.
<department> string X Prospect's department.
<country> string X Prospect's country.
<address_one> string X Prospect's address, line 1.
<address_two> string X Prospect's address, line 2.
<city> string X Prospect's city.
<state> string X Prospect's US state.
<territory> string X Prospect's territory.
<zip> string X Prospect's postal code.
<phone> string X Prospect's phone number.
<fax> string X Prospect's fax number.
<source> string X Prospect's source.
<annual_revenue> string X Prospect's annual revenue.
<employees> string X Prospect's number of employees.
<industry> string X Prospect's industry.
<years_in_business> string X Prospect's number of years in business.
<comments> string X Comments about this prospect.
<notes> string X Notes about this prospect
Note : Available for export, but only exported if selected via fields parameter specified in export create request.
<score> integer X Prospect's score.
<grade> string Prospect's letter grade
Note : Available for export, but only exported if selected via fields parameter specified in export create request.
<last_activity_at> timestamp Time stamp of this prospect's latest visitor activity; Time is reported in API user's preferred timezone.
<recent_interaction> string Describes the prospect's most recent interaction with Pardot (Not available for V3/V4 export) .
<crm_lead_fid> string Prospect's lead ID in a supported CRM system.
<crm_contact_fid> string Prospect's contact ID in a supported CRM system.
<crm_owner_fid> string Prospect's owner ID in a supported CRM system.
<crm_account_fid> string Account ID in a supported CRM system.
<crm_last_sync> timestamp Last time this prospect was synced with a supported CRM system.
<crm_url> string URL to view the prospect within the CRM system (Not available for V3/V4 export) .
<is_do_not_email> boolean X If value is 1, prospect prefers not to be emailed.
<is_do_not_call> boolean X If value is 1, prospect prefers not to be called.
<opted_out> boolean If value is 1, prospect has opted out of marketing communications.
<is_reviewed> boolean X If value is 1, prospect has been reviewed.
<is_starred> boolean X If value is 1, prospect has been starred.
<is_archived> boolean X If value is 1, prospect has been archived.
<created_at> timestamp Time prospect is created in Pardot; Time is reported in API user's preferred timezone.
<updated_at> timestamp Last time prospect was updated in Pardot; Time is reported in API user's preferred timezone.

Additional prospect fields available for Export

When using the v3 Export API or v4 Export API to export prospects, the following prospect fields are selectable for export in addition to the prospect fields listed above.
Note : The following fields are only available via the Export API and are only exported if selected via fields parameter specified in export create request.

Field Name Data Type Description
<converted_at> timestamp Time when prospect was converted from visitor; Time is reported in API user's preferred timezone
<converted_from_object_type> string Type of object associated with visitor activity that resulted in prospect being converted from visitor. Supported values include 'Form', 'FormHandler', 'LandingPage', 'MultivariateTestVariation', and 'Video'.
<converted_from_object_name> string Name of object associated with visitor activity that resulted in prospect being converted from visitor.
<do_not_sell> boolean Indicates whether the visitor recorded an activity with the Global Privacy Control Header enabled.
<is_email_hard_bounced> boolean if value is 1, prospect email address has hard bounced.
<email_bounced_at> timestamp Time when prospect email address hard bounced; Time is reported in API user's preferred timezone.
<email_bounced_reason> string Reason why prospect email address hard bounced.
<first_assigned_at> timestamp Time prospect was first assigned to a user; Time is reported in API user's preferred timezone.
<first_activity_at> timestamp Time when first visitor activity occurred for this prospect; Time is reported in API user's preferred timezone.
<first_referrer_url> string First referrer's URL.
<first_referrer_type> string First referrer's vendor and type (such as 'Google Natural Search').
<first_referrer_query> string First referrer's search query.
<campaign_parameter> string Prospect's campaign parameter utm_campaign from Google Analytics.
<medium_parameter> string Prospect's medium parameter utm_medium from Google Analytics.
<source_parameter> string Prospect's source parameter utm_source from Google Analytics.
<content_parameter> string Prospect's content parameter utm_content from Google Analytics.
<term_parameter> string Prospect's term parameter utm_term from Google Analytics.
<created_by> integer Pardot ID for the user who created this object.
<updated_by> integer Pardot ID for the user who last updated this object.
x

Note: Prospect account fields are fully customizable. To get the most accurate field metadata for your Pardot account, use the describe operation on the prospectAccount API endpoint.

Field Name Data Type Required Editable Description
<id> integer X Pardot ID of the prospect account.
<name> string X The name of the prospect account.

Additional prospect account fields available for Export

When using the v3 Export API or v4 Export API to export prospect account, the following fields are selectable for export in addition to the prospect account fields listed above.
Note : The following fields are only available via the Export API and are only exported if selected via fields parameter specified in export create request.

Field Name Data Type Description
<created_by> integer Pardot ID for the user who created this object.
<updated_by> integer Pardot ID for the user who last updated this object.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this tag.
<name> string Tag's name.
<created_at> timestamp Time tag is created in Pardot. Time is reported in API user's preferred timezone.
<updated_at> timestamp Last time tag was updated. Time is reported in API user's preferred timezone.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID of the tag object.
<tag_id> integer The Pardot ID of the tag.
<type> string The type of object associated with the tag.
<object_id> integer The Pardot ID of the object.
<created_at> timestamp Time tag is associated with the object in Pardot. Time is reported in API user's preferred timezone.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID of the user.
<email> string User's email address.
<first_name> string User's first name.
<last_name> string User's last name.
<job_title> string User's job title
<role> string User's role.
<created_at> timestamp Time user is created in Pardot. Time is reported in the API user's preferred timezone.
<updated_at> timestamp Last time user was updated in Pardot. Time is reported in the API user's preferred timezone.
Field Name Data Type Required Editable Description
<id> integer Pardot ID for this visit.
<visitor_id> integer Pardot ID for the associated visitor.
<prospect_id> integer Pardot ID for the associated prospect.
<visitor_page_view_count> integer Number of page views for this visit.
<first_visitor_page_view_at> timestamp Time of first page view for this visit. Time is reported in API user's preferred timezone
<last_visitor_page_view_at> timestamp Time of last page view for this visit. Time is reported in API user's preferred timezone.
<duration_in_seconds> integer Length of this visit.
<campaign_parameter> string Visit's campaign parameter utm_campaign from Google Analytics.
<medium_parameter> string Visit's medium parameter utm_medium from Google Analytics.
<source_parameter> string Visit's source parameter utm_source from Google Analytics.
<content_parameter> string Visit's content parameter utm_content from Google Analytics.
<term_parameter> string Visit's term parameter utm_term from Google Analytics.
<created_at> timestamp Time visit is created in Pardot. Time is reported in API user's preferred timezone.
<updated_at> timestamp Last time visit was updated in Pardot. Time is reported in API user's preferred timezone.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this visitor.
<page_view_count> integer Number of page views by this visitor.
<ip_address> string Visitor's IP address.
<hostname> string Visitor's hostname.
<campaign_parameter> string Visitor's campaign parameter utm_campaign from Google Analytics
<medium_parameter> string Visitor's medium parameter utm_medium from Google Analytics.
<source_parameter> string Visitor's source parameter utm_source from Google Analytics.
<content_parameter> string Visitor's content parameter utm_content from Google Analytics
<term_parameter> string Visitor's term parameter utm_term from Google Analytics.
<created_at> timestamp Time visitor is created in Pardot. Time is reported in API user's preferred timezone.
<updated_at> timestamp Last time visitor was updated in Pardot. Time is reported in API user's preferred timezone.

When using either the v3 Export API or the v4 Export API to export visitors, the following prospect fields are selectable for export in addition to the Visitor fields listed earlier.

Field Name Data Type Description
< do_not_sell > boolean Indicates whether the visitor recorded an activity with the Global Privacy Control Header enabled.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this visitor activity
<prospect_id> integer Pardot ID for the associated prospect
<visitor_id> integer Pardot ID for the associated visitor
<type> integer Visitor activity's type number. See the listing that follows.
<type_name> string Visitor activity's type name. See the listing that follows.
<details> string Details about this visitor activity. Examples include:
- The name of the object associated with this activity.
- The search phrase used in a site search query.
- Others as your needs require.
<email_id> integer Pardot ID of the email associated with this visitor activity.
Note: This node appears only if this visitor activity has an email associated with it.
<email_template_id> integer Pardot ID of the email template associated with this visitor activity.
Note: This node appears only if this visitor activity has an email associated with it.
<list_email_id> integer Pardot ID of the list email associated with this visitor activity.
Note: This node appears only if this visitor activity has an email associated with it.
<form_id> integer Pardot ID of the form associated with this visitor activity.
Note: This node appears only if this visitor activity has a form associated with it.
<form_handler_id> integer Pardot ID of the form handler associated with this visitor activity.
Note: This node appears only if this visitor activity has a form handler associated with it.
<site_search_query_id> integer Pardot ID of the site search query associated with this visitor activity.
Note: This node appears only if this visitor activity has a site search query associated with it.
<landing_page_id> integer Pardot ID of the landing page associated with this visitor activity.
Note: This node appears only if this visitor activity has a landing page associated with it.
<paid_search_ad_id> integer Pardot ID of the paid search ad associated with this visitor activity.
Note: This node appears only if this visitor activity has a paid search ad associated with it.
<multivariate_test_variation_id> integer Pardot ID of the multivariate test variation associated with this visitor activity.
Note: This node appears only if this visitor activity has a multivariate test variation associated with it.
<file_id> integer Pardot ID of the file associated with this visitor activity.
Note: This node appears only if this visitor activity has a file associated with it.
<custom_redirect_id> integer Pardot ID of the custom redirect associated with this visitor activity. Note: This node appears only if this visitor activity has a custom redirect associated with it.
<campaign> object Campaign information including id, name, and cost. (Not available for V3/V4 export) .
<created_at> timestamp Time that visitor activity occurred. Time is reported in API user's preferred timezone.
<updated_at> timestamp Time that visitor activity update occurred. Time is reported in API user's preferred timezone.

Visitor Activity Types

Visitor Activities have the following values for <type>

  • 1 - Click
  • 2 - View
  • 3 - Error
  • 4 - Success
  • 5 - Session (Omitted from Synchronous and Export endpoints)
  • 6 - Sent
  • 7 - Search
  • 8 - New Opportunity
  • 9 - Opportunity Won
  • 10 - Opportunity Lost
  • 11 - Open
  • 12 - Unsubscribe Page
  • 13 - Bounced
  • 14 - Spam Complaint
  • 15 - Email Preference Page
  • 16 - Resubscribed
  • 17 - Click (Third Party)
  • 18 - Opportunity Reopened
  • 19 - Opportunity Linked
  • 20 - Visit
  • 21 - Custom URL click
  • 22 - Olark Chat
  • 23 - Invited to Webinar
  • 24 - Attended Webinar
  • 25 - Registered for Webinar
  • 26 - Social Post Click
  • 27 - Video View
  • 28 - Event Registered
  • 29 - Event Checked In
  • 30 - Video Conversion
  • 31 - UserVoice Suggestion
  • 32 - UserVoice Comment
  • 33 - UserVoice Ticket
  • 34 - Video Watched (≥ 75% watched)
  • 35 - Indirect Unsubscribe Open
  • 36 - Indirect Bounce
  • 37 - Indirect Resubscribed
  • 38 - Opportunity Unlinked
  • Other - Unknown
Field Name Data Type Required Editable Description
<id> integer Pardot ID for this visitor page view.
<url> string Page view. URL
<title> string Page title.
<created_at> timestamp Time page view occurred. Time is reported in API user's preferred timezone.
Field Name Data Type Required Editable Description
<id> integer X Pardot ID for this visitor referrer.
<referrer> string Referrer's URL.
<vendor> string Referrer's vendor (such as 'Google' or 'Yahoo').
<type> string Referrer's type (such as 'Natural Search').
<query> string Referrer's search query.
Read article