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.

The API to access the dynamic content object follows the conventions described in Version 5 Overview.

Operation	HTTP Verb	URL Format	Ability Requirements
Read	`GET`	`https://pi.pardot.com/api/v5/objects/dynamic-contents/<id>?<params>`	Content > Dynamic Content > View ability
Query	`GET`	`https://pi.pardot.com/api/v5/objects/dynamic-contents?<params>`	Content > Dynamic Content > View ability

Required Read-Only Fields

Field	Type	Description
`id`	Integer	Account Engagement ID for this dynamic content.

Read-Only Fields

Field	Type	Description
`name`	String	Dynamic content's name.
`embedCode`	String	The code used to embed the dynamic content into a web page.
`embedUrl`	String	The URL to embed this dynamic content.
`baseContent`	String	The default content that shows when the prospect doesn't meet the criteria for a variation.
`basedOn`	Enum	The kind field that dynamic content is based on. Values are "default", "custom", "grade", and "score".
`createdAt`	DateTime	Time the dynamic content was created; reported in API user's timezone.
`updatedAt`	DateTime	Time the dynamic content was last updated; reporting in API user's timezone.
`isDeleted`	Boolean	When `true`, the object is in the recycle bin in Account Engagement.
`createdById`	Integer	ID of the user who created this object.
`updatedById`	Integer	ID of the user who last updated this object.
`folderId`	Integer	ID of the folder containing this object.
`trackerDomainId`	Integer	The ID of the tracker domain associated with this object.
`createdBy`	User	User object representing the user who created this object. See documentation for User for fields.
`updatedBy`	User	User object representing the user who last updated this object. See documentation for User for fields.
`campaign`	Campaign	Campaign object representing the campaign that was set on Create. See documentation for Campaign for fields.
`folder`	Folder	JSON object representing the folder for this object. See documentation for Folder for fields.
`trackerDomain`	Tracker Domain	Tracker Domain object representing the tracker domain associated with the email template. See documentation for Tracker Domain for fields.
`tagReplacementLanguage`	Enum	Merge language of the dynamic content. Can be `"pml"`, `"hml"`, or `"undetermined"`.

Retrieve a single dynamic content following the conventions described in the Version 5 Overview.

Example request:

Example response:

Retrieve a collection of dynamic content following the conventions described in the Version 5 Overview.

Sortable Fields

id
createdAt
updatedAt

Filtering Results

When executing a query, the following parameters can be used to filter the returned results. These parameters can be specified in the request along with any shared parameters defined in Version 5 Overview. When specifying more than one parameter, all parameters must match the record in order for it to be returned in the results.

Parameter	Description
`id`	Returns any dynamic content where ID is equal to the given integer value.
`idGreaterThan`	Returns any dynamic content where ID is greater than the specified value, non-inclusive.
`idGreaterThanOrEqualTo`	Returns any dynamic content where ID is greater than or equal to the specified value.
`idLessThan`	Returns any dynamic content where ID is less than the specified value, non-inclusive.
`idLessThanOrEqualTo`	Returns any dynamic content where ID is less than or equal to the specified value.
`createdAt`	Returns any dynamic content where CreatedAt is equal to the given datetime value.
`createdAtAfter`	Returns any dynamic content where CreatedAt is after the given datetime value, non-inclusive.
`createdAtAfterOrEqualTo`	Returns any dynamic content where CreatedAt is after or equal to the given datetime value.
`createdAtBefore`	Returns any dynamic content where CreatedAt is before the given datetime value, non-inclusive.
`createdAtBeforeOrEqualTo`	Returns any dynamic content where CreatedAt is before or equal to the given datetime value.
`updatedAt`	Returns any dynamic content where UpdatedAt is equal to the given datetime value.
`updatedAtAfter`	Returns any dynamic content where UpdatedAt is after the given datetime value, non-inclusive.
`updatedAtAfterOrEqualTo`	Returns any dynamic content where UpdatedAt is after or equal to the given datetime value.
`updatedAtBefore`	Returns any dynamic content where UpdatedAt is before the given datetime value, non-inclusive.
`updatedAtBeforeOrEqualTo`	Returns any dynamic content where UpdatedAt is before or equal to the given datetime value.
`deleted`	Determines whether to return deleted records. The value can be `false` (default), `true`, or `all`.

Example Request

Example Response