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
CRM-Salesforce
Salesforce Developers

Email Click Object

Pardot emails can contain links to download files. Use email click resources to learn more about how your prospects interact with the email links. Learn more about email clicks in Salesforce Help.

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

Resource Name Operation Description
Email Clicks Query GET Request information for the email clicks that matches the specified criteria.

Request information for email clicks that match the specified criteria. You can specify the email clicks and the fields to request. A maximum of 200 are returned.

URI

Parameters to Select Email Clicks

Use these parameters to specify which email clicks 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 ).
  • For a full listing of email clicks 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 email clicks created after the specified time. Example: To request forms created in 2020, use /api/emailClicks/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 email clicks created before the specified time. Doesn’t include email clicks created at the specified time. Example : To request email clicks created before today (but not created today), use /api/emailClicks/version/3/do/query?created_before=today .
id_greater_than integer Any positive integer Request email clicks that have a Pardot ID greater than the specified number. Example: to request email clicks resulting from emails that were sent by the email list with Pardot ID 126xx, and that have a Pardot ID greater than 123, use api/emailClick/version/3/do/query?id_greater_than=123&list_email_id=126xx .
list_email_id integer Any positive integer Selects only email clicks generated by assets whose list email matches the specified Pardot ID. Example: to request email clicks from emails that were sent by the email list with Pardot ID 1263xx, use /api/emailClick/version/3/do/query?list_email_id=1263xx
drip_program_action_id integer Any positive integer Deprecated. Selects only email clicks generated by an engagement program action with the specified Pardot ID.
email_template_id integer Any positive integer Selects only email clicks generated by the email template with the specified Pardot ID.
tracker_redirect_id integer Any positive integer Selects only email clicks generated by the tracker redirect with the specified Pardot ID.
Tag Description
<result> Parent tag. Contains information about the email clicks that match the parameters specified in your query.
<total_results> Contains the number of email clicks selected by the query. Note: The query request returns a maximum of 200 email clicks. If your query matches more than 200 email clicks, you can make several requests to retrieve all matching records.
<emailClick> The information for a single email click. See Email Clicks in Object Field References.
Salesforce Developers

Campaign Object

A Pardot campaign tracks the first interaction that a person has with your online marketing materials. Associate your assets to a Pardot campaign to organize and track your marketing efforts. Learn more about Pardot campaigns in Salesforce Help.

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

Resource Name Operations Description
Campaign Create POST Create a campaign record.
Campaign Read GET Request information for a single campaign.
Campaign Query GET Request information for the campaigns that match the specified criteria.
Campaign Update POST Update a campaign's information, including campaign fields.

Note: We recommend using Salesforce Connected Campaigns. When Connected Campaigns is enabled, only Campaign Read and Campaign Query are available.

Create a campaign with the specified fields.

URI

Parameters

You can use any campaign field as a parameter. For a list of campaign fields, see Campaign.

Example

Create a campaign with the name New Campaign and a cost of 2,000.

Request information for a single campaign.

URI

Replace <ID> with the Pardot ID of the campaign.

Example

Request information for the campaign with ID 12341xxx.

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

Note: To request information about a specific campaign, use Campaign Read.

URI

Parameters to Select Campaigns

Use these parameters to specify which campaigns 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 ).
  • For a full listing of campaign 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 campaigns created after the specified date and time. Example: To request forms created in 2020, use /api/campaigns/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 campaigns created before the specified date and time. Doesn’t include campaigns created at the specified time. <custom_time> Example : to request campaigns created before today (but not created today), use /api/campaign/version/3/do/query?created_before=today .
id_greater_than integer Any positive integer Request campaigns that have a Pardot ID greater than the specified number.
id_less_than integer Any positive integer Returns campaigns that have a Pardot ID less than the specified number.
name string string Request campaigns with the specified name.
updated_after string today , yesterday , last_7_days , this_month , last_month , <custom_time> Request campaigns 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 campaigns that were last updated before the specified date and time.

Parameters to Specify Which Results Are Returned

Use these parameters to specify which campaign fields are returned, and how the campaigns are sorted.

Parameter Type Possible Values Description
limit integer Any integer from 1 through 200. The number of campaigns to return. Default value is 200.
offset integer Any positive integer The number of campaigns to omit from the response (the number to "skip over"). Example: Retrieve a list of campaigns, omitting the 50 most recently updated campaigns. Sort the query by the updated_at field and use offset=50: api/campaign/version/3/do/query?sort_by=updated_at&offset=50
sort_by string created_at , id , name , updated_at , cost 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 campaigns' created_at timestamps.
id ascending Sort the results by the campaigns' id fields.
name ascending Sort the results by the campaigns' name fields.
updated_at descending Sort the results by the campaigns' updated_at timestamps.
cost descending Sort the results by the campaigns' cost fields.

Example

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

Update a campaign's information, including campaign fields. 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 campaign.

URI

Replace <ID> with the Pardot ID of the campaign.

Parameters

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

Example

To update a campaign's name to "March Webinar" and reset the cost as blank, use the following POST command:

The XML response for a query request contains information about multiple campaigns. The XML response for a read request contains information about a single campaign.

XML Response for Campaign Query

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

XML Response for Campaign Read

Tag Description
<campaign> The information for a single campaign. For information about campaign fields, see Campaign.
Read article
Salesforce Developers

Custom Field Object

Use custom fields to capture and track more data about your prospects. You can use custom fields in forms and sync the Pardot fields with Salesforce fields. Learn more about Pardot fields in Salesforce Help.

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

Resource Name Operation Description
Custom Field Create POST Create a custom field.
Custom Field Read GET Request detailed information for a single custom field.
Custom Field Update POST Update a custom field's value.
Custom Field Delete POST or DELETE Delete a custom field.
Custom Field Query GET Request information for the custom fields that match the specified criteria.

Create a custom field with the specified name and API name.

URI

Parameters

The following parameters are required to create a new custom field:

Parameter Type Description
name string The name of the custom field.
field_id string The API name of the custom field.

Parameters can include any editable field in the Custom Field object. For a list of fields in the Custom Field object, see Custom Field.

Example

Create a custom field of type integer with the name "Partner Level" and the API name "PARTNER_LEVEL_c," which doesn’t allow multiple values.

Delete a custom field specified by custom field ID.

URI

Replace <ID> with the ID of the custom field.

Example

Delete the custom field with ID 5746xx.

Request information about the specified custom field.

URI

Replace <ID> with the ID of the custom field.

Example

Request the information for the custom field with ID 12341xxx

Request information about custom fields that match the specified criteria. You can specify which custom field records and fields to request. A maximum of 200 custom fields are returned. To return all custom fields, specify the output as mobile .

To request information about a specific custom field, use Custom Field Read.

URI

Parameters to Select Custom Fields

Use these parameters to specify which custom fields are returned. Parameters can be used in any combination and 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 ).
  • For a full listing of custom fields see Object Field References.
Parameter Type Options Description
created_after string today , yesterday , last_7_days , this_month , last_month , <custom_time> Request custom fields created after the specified time. Example: To request forms created in 2020, use /api/customField/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 custom fields created before the specified date and time. Does not include custom fields created at the specified time. <custom_time> Example : to request custom fields created before today (but not created today), use /api/customField/version/3/do/query?created_before=today .
id_greater_than integer Any positive integer Requests custom fields that have an ID greater than the specified number.
id_less_than integer Any positive integer Returns custom fields that have an ID less than the specified number.

Parameters to Specify Which Results Are Returned

Use these parameters to specify which custom fields are returned, and how the custom fields are sorted.

Parameter Type Options Description
limit integer Any integer from 1 through 200 The number of custom fields to return. Default value is 200.
offset integer Any positive integer The number of custom fields to omit from the response (the number to "skip over"). Example: Retrieve a list of custom fields, omitting the 50 most recently updated custom fields. Sort the query by the updated_at field and use offset=50: /api/customField/version/3/do/query?offset=50&sort_by=created_at
sort_by string created_at , id , probability , value 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 parameter you specify. See Sort Order.

Sort Order

Use the sort_by parameter 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 custom fields' created_at timestamps.
id ascending Sort the results by the custom fields' id fields.
name ascending Sort the results by the custom fields' name fields.

Updates information for the specified custom field. Specify the custom field by custom field ID. Fields that are not specified in the request are not changed. To clear a field, use a null value.

Returns an updated version of the custom field.

URI

Replace <ID> with the ID of the custom field.

Parameters

You can use any field in a Custom Field object as a parameter. For a list of fields in a Custom Field object, see Custom Field.

Example

To update a custom field's name to "CONTACTED", use the following POST command:

The XML response for a query request contains information about multiple custom fields. The XML response for a read request contains information about a single custom field.

XML Response for Custom Field Query

Tag Description
<result> Parent tag. Contains the custom fields that match the parameters specified in your query.
<total_results> The number of custom fields selected by the query. Note: The query request returns a maximum of 200 custom fields. If your query matches more than 200 custom fields, you can make several requests to retrieve all matching custom fields.
<customField> The information for a single custom field. See Custom Field.

XML Response for Custom Field Read

Tag Description
<customField> The information for a single custom field. See Custom Field.
Read article
Salesforce Developers

Custom Redirect Object

Track links on your website or third-party site with Pardot’s custom redirects. For example, you can track a link on your Twitter page or a banner ad on a third-party site. When a user clicks a link, a corresponding activity is created on their profile. Learn about custom redirects in Salesforce Help.

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

Resource Name Operation Description
Custom Redirect Read GET Request information for a single custom redirect record.
Custom Redirect Query GET Request information for custom redirects that match the specified criteria.

Request information for a single custom redirect record.

URI

Replace <ID> with the Pardot ID of the custom redirect.

Example

Request the information for the custom redirect with ID 1234.

Requests information about custom redirects that match the specified criteria. You can specify the custom redirects and fields to request. A maximum of 200 custom redirects are returned. To return all custom redirects, specify the output as mobile .

To request information about a specific custom redirect, use Custom Redirect Read.

URI

Parameters to Select Custom Redirects

Use these parameters to specify the custom redirects to return. 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 ).
  • For a full listing of custom redirect fields see Object Field References.
Parameter Type Possible Values Description
created_after string today , yesterday , last_7_days , this_month , last_month , <custom_time> Requests custom redirects created after the specified time. Example: To request custom redirects created in 2020, use //api/customRedirect/version/3/do/query?created_after=2019-12-31%2024:59:59 .
created_before string today , yesterday , last_7_days , this_month , last_month , <custom_time> Requests custom redirects created before the specified date and time. Doesn’t include custom redirects created at the specified time. Example : To request custom redirects created before today (but not created today), use /api/customRedirect/version/3/do/query?created_before=today .
id_greater_than integer Any positive integer Requests custom redirects that have an ID greater than the specified number.
id_less_than integer Any positive integer Returns custom redirects that have an ID less than the specified number.
updated_after string today , yesterday , last_7_days , this_month , last_month , <custom_time> Requests custom redirects that were last updated after the specified date and time.
updated_before string today , yesterday , last_7_days , this_month , last_month , <custom_time> Selects custom redirects that were last updated before the specified date and time.

Parameters to Specify Which Results Are Returned

Use these parameters to specify which custom redirect fields are returned, and how the custom redirects are sorted.

Parameter Type Possible Values Description
limit integer Any integer from 1 through 200. The number of custom redirects to return. Default value is 200.
offset integer Any positive integer The number of custom redirects to omit from the response (the number to "skip over"). Example: Retrieve a list of custom redirects, omitting the 50 most recently updated custom redirects. Sort the query by the updated_at field and use offset=50: api/customRedirect/version/3/do/query?sort_by=updated_at&offset=50
sort_by string created_at , id The field by which the results are sorted. See Sort Order.
sort_order string ascending , descending , updated_at The sort order. The default value depends on which sort_by parameter you specify. See Sort Order.

Sort Order

Use the sort_by parameter 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 custom redirects' created_at timestamps.
id ascending Sort the results by the custom redirects' id fields.
updated_at descending Sort the results by the custom redirects' updated_at timestamps.

The XML response for a query request contains information about multiple custom redirects. The XML response for a read request contains information about a single custom redirect.

XML Response for a Custom Redirect Query

Tag Description
<result> Parent tag. The custom redirects that match the parameters specified in your query.
<total_results> The number of custom redirects selected by the query. Note : The query request returns a maximum of 200 custom redirects. If your query matches more than 200 custom redirects, you can make several requests to retrieve all matching custom redirects.
<customRedirect> The information for a single custom redirect. See Custom Redirect in Object Field References.
Tag Description
<customRedirect> The information for a single custom redirect. See Custom Redirect in Object Field References.
Read article
Salesforce Developers

Dynamic Content Object

Dynamic content personalizes parts of your website based on what you know about a viewer. Learn more about dynamic content in Salesforce Help.

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

Resource Name Operation Description
Dynamic Content Query GET Request information for dynamic content that matches the specified criteria.
Dynamic Content Read GET Request information for a single dynamic content record.

Request information for the dynamic content records that match the specified criteria. You can specify the dynamic content records and fields to request. A maximum of 200 records are returned. To return all dynamic content records, specify the output as mobile .

URI

Parameters to Select Dynamic Content Records

Use these parameters to specify the dynamic content records to return. 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 (for example, yyyy-mm-dd:hh:ss ).
  • For a full listing of dynamic content 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 dynamic content records created after the specified time. Example: To request forms created in 2020, use /api/dynamicContent/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 dynamic content records created before the specified time. Doesn’t include dynamic content records created at the specified time. Example : To request dynamic content records created before today (but not created today), use /api/dynamicContent/version/3/do/query?created_before=today .
id_greater_than integer Any positive integer Request dynamic content records that have an ID greater than the specified number.
id_less_than integer Any positive integer Request dynamic content records that have an ID less than the specified number.
updated_after string today , yesterday , last_7_days , this_month , last_month , <custom_time> Request dynamic content records that were last updated after the specified time.
updated_before string today , yesterday , last_7_days , this_month , last_month , <custom_time> Request dynamic content records that were last updated before the specified time.

Parameters to Specify Which Results Are Returned

Use these parameters to specify the dynamic content fields to return, and how the dynamic content records are sorted.

Parameter Type Possible Values Description
limit integer Any integer from 1 through 200. The number of dynamic content records to return. Default value is 200.
offset integer Any positive integer The number of dynamic content records to omit from the response (the number to "skip over"). Example: Retrieve a list of dynamic content records, omitting the 50 most recently updated records. Sort the query by the updated_at field and use offset=50: /api/dynamicContent/version/3/do/query?sort_by=updated_at&offset=50
sort_by string created_at , id , updated_at The field by which the results are sorted. See Sort Order.
sort_order string ascending, descending The version/3. The default value depends on which sort_by parameter 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 dynamic content records' created_at timestamps.
id ascending Sort the results by the dynamic content records' id fields.
updated_at descending Sort the results by the dynamic content records' updated_at timestamps.

Request information for a single dynamic content record.

URI

Replace <ID> with the Pardot ID of the dynamic content record.

Example

Request information about the dynamic content record with ID 1234.

The XML response for a query request contains information for multiple dynamic content records. The XML response for a read request contains information for a single dynamic content record.

XML Response for a Dynamic Content Query

Tag Description
<result> Parent tag. Contains the dynamic content records that match the parameters specified in your query.
<total_results> Contains the number of dynamic content records selected by the query. Note The query request returns a maximum of 200 dynamic content records. If your query matches more than 200 records, you can make several requests to retrieve all matching records.
<dynamicContent> The information about a single dynamic content record. See Dynamic Content in Object Field References for a complete description of fields.

XML Response for a Dynamic Content Read

Tag Description
<dynamicContent> The information about a single dynamic content record. See Dynamic Content in Object Field References for a description of fields.
Read article
Salesforce Developers

Email Template Object

Use an email template to design a reusable email layout for your engagement programs, autoresponders, one-to-one emails, and list emails. Learn about email templates in Salesforce Help.

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

Resource Name Operation Description
Email Template Read GET Request information about a single email template.
One-to-One Email Templates GET Request information about the email templates that are used in one-to-one emails.

Request information about a single email template.

URI

Replace <ID> with the Pardot ID of the email template.

Parameters to Select a Template

Use this parameter to specify the email templates to return.

Parameter Type Possible Values Description
archived boolean true , false If true , the request returns archived and unarchived templates. If false , only unarchived templates are returned. Default value is false .

Request the email templates that are enabled for one-to-one emails.

URI

Parameters to Select One-to-One Email Templates

Use this parameter to specify which one-to-one email templates to return.

Parameter Type Possible Values Description
archived boolean true , false If true , the request returns both archived and unarchived templates. If false , only unarchived templates are returned. Default is false .

Use the XML response for read requests and one-to-one requests to learn more about your email templates.

XML Response for an Email Template Read

Tag Description
<emailTemplate> Parent tag. Contains data fields for a single email template.
<error> Flag if an error occurred.
<errorCode> Code for the error which occurred.
<errorMessage> Description of the error.
<sendOptions> The associated send options object, including sender-specific data.
<replyToAddress> The email address in the email's Reply-To header.
<sendFromData> A JSON array representing the sender hierarchy tied to the email template.
<id> The Pardot ID of the email template.
<name> The name of the email template.
<htmlMessage> The HTML version of the email template body.
<textMessage> The plain text version of the email template body.
<isDripEmail> Flag if the template is available for use in engagement programs.
<isListEmail> Flag if the template is available for use in list emails.
<subject> The subject of the email message.

XML Response for One-to-One Email Templates

Tag Description
<emailTemplates> Parent tag. Contains individual email template records.
<templates> Parent tag for each template.
<id> The Pardot ID of the email template.
<name> The name of the email template.
<isOneToOneEmail> Flag if the email template is available for use in one-to-one emails (always true).
<isArchived> Flag if the email template is in the Recycle Bin in Pardot.
<isAutoResponderEmail> Flag if the email template is available for use as an auto response from a form submission.
<isDripEmail> Flag if the email template is available for use in engagement programs.
<isListEmail> Flag if the email template is available for use in list emails.
<subject> The subject of the email message.
Read article