Pardot's developer content is getting a makeover! Starting July 12th, you’ll be redirected to our new site.

Prospect Account Resources

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.

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

Resource Name	Operation	Description
Prospect Account Assign	`POST`	Assign a prospect to a prospect account.
Prospect Account Create	`POST`	Create a prospect account.
Prospect Account Describe	`GET`	Request the field metadata for prospect accounts.
Prospect Account Read	`GET`	Request information for a single prospect account.
Prospect Account Query	`GET`	Request information for the prospect accounts that match the specified criteria.
Prospect Account Update	`POST`	Update 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

/api/prospectAccount/version/3/do/assign/id/<ID>

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.

POST /api/prospectAccount/version/3/do/assign/id/5678 HTTP/1.1
Host: pi.pardot.com
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer <ACCESS TOKEN>
Pardot-Business-Unit-Id: <BUSINESS UNIT ID>

user_id=1234

Prospect Account Create

Create a prospect account with the specified fields.

URI

/api/prospectAccount/version/3/do/create?...

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".

POST /api/prospectAccount/version/3/do/create HTTP/1.1
Host: pi.pardot.com
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer <ACCESS TOKEN>
Pardot-Business-Unit-Id: <BUSINESS UNIT ID>

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

/api/prospectAccount/version/3/do/describe

Prospect Account Read

Request information for a single prospect.

URI

/api/prospectAccount/version/3/do/read/id/<ID>?..

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

Example

Request information for the prospect account with ID 1234.

/api/prospectAccount/version/3/do/read/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.

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

URI

/api/prospectAccount/version/3/do/query?...

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:

Parameters must be URL-encoded.
Dates and times must use GNU Date Input Syntax (yyyy-mm-dd:hh:ss:mm).
For a full listing of prospect fields see Object Field References.

Parameter	Type	Possible Values	Description
`created_after`	`string`	`today`, `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/3/do/query?created_after=2019-12-31 24:59:59`.
`created_before`	`string`	`today`, `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/3/do/query?created_before=today`.
`id_greater_than`	`integer`	Any positive integer	Request prospect accounts that have a Pardot ID greater than the specified number.
`id_less_than`	`integer`	Any positive integer	Request prospect accounts that have a Pardot ID less than the specified number.
`name`	`string`	string	Request prospect accounts with the specified name.
`updated_after`	`string`	`today`, `yesterday`, `last_7_days`, `this_month`, `last_month`, `<custom_time>`	Request prospect accounts that were last updated after the specified date and time.
`updated_before`	`string`	`today`, `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.

Parameter	Type	Possible Values	Description
`fields`	`array`	Any valid Pardot field IDs.	The fields to return. Separate fields by a comma.
`limit`	`integer`	Any integer from 1 through 200.	The number of prospect accounts to return. Default value is 200.
`offset`	`integer`	Any positive integer	The 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/3/do/query?sort_by=updated_at&offset=50`
`sort_by`	`string`	`created_at`, `id`, `name`, `updated_at`	The field by which the results are sorted. See Sort Order.
`sort_order`	`string`	`ascending, descending`	The 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.

Value	Default Sort Order	Description
`created_at`	descending	Sort the results by the prospect accounts' `created_at` timestamps.
`id`	ascending	Sort the results by the prospect accounts' `id` fields.
`name`	ascending	Sort the results by the prospect accounts' `name` fields.
`updated_at`	ascending	Sort the results by the prospect accounts' `updated_at` timestamps.

Example

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

/api/prospectAccount/version/3/do/query?sort_order=ascending&sort_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

/api/prospectAccount/version/3/do/update/id/<ID>?...

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:

 /api/prospectAccount/version/3/do/update/id/1234?name=My Account

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

<rsp stat="ok" version="1.0">
    <result>
        <total_results>...</total_results>
        <prospectAccount>...</prospectAccount>
        <prospectAccount>...</prospectAccount>
        <prospectAccount>...</prospectAccount>
    </result>
</rsp>

Tag	Description
`<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

<rsp stat="ok" version="1.0">
    <prospectAccount>

    </prospect>
</rsp>

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