Prospect Account Object

Prospect accounts group prospect accounts that work for the same company under the same umbrella, keeping all the information about the company in one place. Use prospect account resources to request the name and Pardot ID of your prospect accounts. Learn more about prospect accounts in Salesforce Help.

Include the authentication header with every request. For information on how to authenticate, see Authentication.

Prospect Account Resources

Resource NameOperationDescription
Prospect Account AssignPOSTAssign a prospect to a prospect account.
Prospect Account CreatePOSTCreate a prospect account.
Prospect Account DescribeGETRequest the field metadata for prospect accounts.
Prospect Account ReadGETRequest information for a single prospect account.
Prospect Account QueryGETRequest information for the prospect accounts that match the specified criteria.
Prospect Account UpdatePOSTUpdate a prospect account's information, including the Pardot ID of the prospect account, and the prospect account name.

Prospect Account Assign

Assign a prospect to a prospect account. You can specify the prospect by Pardot ID or email address.

URI

Parameters

You can use any prospect account field as a parameter. For a list of prospect fields, see Prospect Account.

Example

Assign the prospect with ID 1234 to the prospect account with ID 5678.

Prospect Account Create

Create a prospect account with the specified fields.

URI

Parameters

You can use any prospect account field as a parameter. For a list of prospect fields, see Prospect Account.

Example

Create a prospect account with the name "My Account".

Prospect Account Describe

Request the field metadata for prospect accounts. The metadata describes which fields are available, their types, whether they’re required, and their option.

URI

Prospect Account Read

Request information for a single prospect.

URI

Replace <ID> with the Pardot ID of the prospect account.

Example

Request information for the prospect account with ID 1234.

Prospect Account Query

Request information about the prospect accounts that match the specified criteria. You can specify which prospect accounts and which fields to request. A maximum of 200 prospect accounts are returned, unless you specify the output as mobile. If you specify the output as mobile, then all prospect accounts are returned.

To request information about a specific prospect account, use Prospect Account Read.

URI

Parameters to Select Prospect Accounts

Use these parameters to specify which prospect accounts are returned. Parameters can be used in any combination and in any order unless otherwise specified.

Notes:

ParameterTypePossible ValuesDescription
created_afterstringtoday, yesterday, last_7_days, this_month, last_month,<custom_time>Request prospect accounts created after the specified date and time. Example: To request prospect accounts created in 2020, use /api/prospectAccounts/version/4/do/query?created_after=2019-12-31 24:59:59.
created_beforestringtoday, yesterday, last_7_days, this_month, last_month, <custom_time>Request prospect accounts created before the specified date and time. Doesn’t include prospect accounts created at the specified time. <custom_time> Example: to request prospect accounts created before today (but not created today), use /api/prospectAccount/version/4/do/query?created_before=today.
id_greater_thanintegerAny positive integerRequest prospect accounts that have a Pardot ID greater than the specified number.
id_less_thanintegerAny positive integerRequest prospect accounts that have a Pardot ID less than the specified number.
namestringstringRequest prospect accounts with the specified name.
updated_afterstringtoday, yesterday, last_7_days, this_month, last_month, <custom_time>Request prospect accounts that were last updated after the specified date and time.
updated_beforestringtoday, yesterday, last_7_days, this_month, last_month, <custom_time>Request prospect accounts that were last updated before the specified date and time.

Parameters to Specify Which Results Are Returned

Use these parameters to specify which prospect account fields are returned, and how the prospect accounts are sorted.

ParameterTypePossible ValuesDescription
fieldsarrayAny valid Pardot field IDs.The fields to return. Separate fields by a comma.
limitintegerAny integer from 1 through 200.The number of prospect accounts to return. Default value is 200.
offsetintegerAny positive integerThe number of prospect accounts to omit from the response (the number to "skip over"). Example: Retrieve a list of prospect accounts, omitting the 50 most recently updated prospect accounts. Sort the query by the updated_at field and use offset=50: api/prospect/version/4/do/query?sort_by=updated_at&offset=50
sort_bystringcreated_at, id, name, updated_atThe field by which the results are sorted. See Sort Order.
sort_orderstringascending, descendingThe sort order. The default value depends on which sort_by value you specify. See Sort Order.

Sort Order

Use sort_by to specify which field Pardot uses to sort the results. Different fields have different default sort orders.

ValueDefault Sort OrderDescription
created_atdescendingSort the results by the prospect accounts' created_at timestamps.
idascendingSort the results by the prospect accounts' id fields.
nameascendingSort the results by the prospect accounts' name fields.
updated_atascendingSort the results by the prospect accounts' updated_at timestamps.

Example

Request a list of prospect accounts, sorted in ascending order by cost.

Prospect Account Update

Update a prospect account's information. Fields that aren’t specified in the request aren’t changed. To clear a field, use a null value.

Returns an updated version of the prospect account.

URI

Replace <ID> with the Pardot ID of the prospect account.

Parameters

You can use any prospect account field as a parameter. For a list of prospect account fields, see Object Field References.

Example

To update prospect account's name to "My Account", use the following command:

XML Response

The XML response for a query request contains information about multiple prospect accounts. The XML response for a read request contains information about a single prospect account.

XML Response for Prospect Account Query

TagDescription
<result>Parent tag. Contains the prospect accounts that match the parameters specified in your query.
<total_results>The number of prospect accounts selected by the query. Note: The query request returns a maximum of 200 prospect accounts. If your query matches more than 200 prospect accounts, you can make several requests to retrieve all matching records.
<prospectAccount>The information for a single prospect account. For information about prospect account fields, see Prospect.

XML Response for Prospect Account Read

TagDescription
<prospectAccount>The information for a single prospect account. For information about prospect fields, see Prospect.