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.

OperationHTTP VerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/dynamic-contents/<id>?<params>Content > Dynamic Content > View ability
QueryGEThttps://pi.pardot.com/api/v5/objects/dynamic-contents?<params>Content > Dynamic Content > View ability
CreatePOSThttps://pi.pardot.com/api/v5/objects/dynamic-contents?<params>Content > Dynamic Content > Create ability
FieldTypeDescription
nameStringDynamic Content's name. Must be unique.
basedOnProspectApiFieldIdStringThe name of the Account Engagement prospect field that the Dynamic Content is mapped to. On standard fields the value is the name of the field. For example, "firstName". If mapping to a custom field, the value is the field name followed by __c. For example, the custom field "foodChoice" becomes "foodChoice__c".
FieldTypeDescription
baseContentStringThe default content that shows when the prospect doesn't meet the criteria for a variation.
folderIdIntegerID of the folder containing this object. Uses the asset type's uncategorized folder if not specified on create.
trackerDomainIdIntegerThe ID of the tracker domain associated with this object. Uses the default tracker domain if not specified on create.
FieldTypeDescription
idIntegerAccount Engagement ID for this dynamic content.
embedCodeStringThe code used to embed the dynamic content into a web page.
embedUrlStringThe URL to embed this dynamic content.
basedOnEnumThe kind field that dynamic content is based on. Values are "default", "custom", "grade", and "score".
tagReplacementLanguageEnumMerge language of the dynamic content. Can be "pml", "hml", or "undetermined".
createdAtDateTimeTime the dynamic content was created; reported in API user's timezone.
updatedAtDateTimeTime the dynamic content was last updated; reporting in API user's timezone.
isDeletedBooleanWhen true, the object is in the recycle bin in Account Engagement.
createdByIdIntegerID of the user who created this object.
updatedByIdIntegerID of the user who last updated this object.
createdByUserUser object representing the user who created this object. See documentation for User for fields.
updatedByUserUser object representing the user who last updated this object. See documentation for User for fields.
campaignCampaignCampaign object representing the campaign that was set on Create. See documentation for Campaign for fields.
folderFolderJSON object representing the folder for this object. See documentation for Folder for fields.
trackerDomainTracker DomainTracker Domain object representing the tracker domain associated with the email template. See documentation for Tracker Domain for fields.

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.

  • id
  • createdAt
  • updatedAt

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.

ParameterDescription
idReturns any dynamic content where ID is equal to the given integer value.
idListReturns any dynamic content where ID is included in the given list of values.
idGreaterThanReturns any dynamic content where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any dynamic content where ID is greater than or equal to the specified value.
idLessThanReturns any dynamic content where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any dynamic content where ID is less than or equal to the specified value.
nameReturns any dynamic content where Name is equal to the given string value.
createdAtReturns any dynamic content where CreatedAt is equal to the given datetime value.
createdAtAfterReturns any dynamic content where CreatedAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any dynamic content where CreatedAt is after or equal to the given datetime value.
createdAtBeforeReturns any dynamic content where CreatedAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any dynamic content where CreatedAt is before or equal to the given datetime value.
updatedAtReturns any dynamic content where UpdatedAt is equal to the given datetime value.
updatedAtAfterReturns any dynamic content where UpdatedAt is after the given datetime value, non-inclusive.
updatedAtAfterOrEqualToReturns any dynamic content where UpdatedAt is after or equal to the given datetime value.
updatedAtBeforeReturns any dynamic content where UpdatedAt is before the given datetime value, non-inclusive.
updatedAtBeforeOrEqualToReturns any dynamic content where UpdatedAt is before or equal to the given datetime value.
deletedDetermines whether to return deleted records. The value can be false (default), true, or all.

Example Request

Example Response

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

Example request:

Example response:

The object supports these enums.

  • A+
  • A
  • A-
  • B+
  • B
  • B-
  • C+
  • C
  • C-
  • D
  • F