Landing Page Object

A landing page is a web page that a visitor reaches after clicking a link or advertisement. This page generally displays content that’s specific to the advertisement, search keyword, or link clicked. Landing page visitors can be more likely to convert when you present them with relevant, actionable content.

Learn more about landing pages in Salesforce Help.

The API to access the Landing Page object follows the conventions described in Version 5 Overview.

Operation	HTTP Verb	URL Format	Ability Requirements
Create	`POST`	`https://pi.pardot.com/api/v5/objects/landing-pages?<params>`	Landing Pages > Landing Page > Create
Read	`GET`	`https://pi.pardot.com/api/v5/objects/landing-pages/<id>?<params>`	Landing Pages > Landing Page > View
Query	`GET`	`https://pi.pardot.com/api/v5/objects/landing-pages?<params>`	Landing Pages > Landing Page > View
Add Tag	`POST`	`https://pi.pardot.com/api/v5/objects/landing-pages/<id>/do/addTag`	Landing Pages > Landing Page > Create AND Marketing > Segmentation > Tags > Create
Remove Tag	`POST`	`https://pi.pardot.com/api/v5/objects/landing-pages/<id>/do/removeTag`	Landing Pages > Landing Page > Create AND Marketing > Segmentation > Tags > Create
Copy to CMS	`POST`	`https://pi.pardot.com/api/v5/objects/landing-pages/<id>/do/copyToCms`	Landing Pages > Landing Page > Copy to CMS

Field	Type	Description
`name`	String	Name of the object for identification in Account Engagement.
`campaignId`	Integer	ID of the campaign related to this object.

Field	Type	Description
`folderId`	Integer	ID of the folder containing this object.
`formId`	Integer	ID of the form related to this object.
`layoutTemplateId`	Integer	ID of the layout template related to this object.
`title`	String	The landing page's title.
`description`	String	The landing page's meta description. Used for SEO.
`isDoNotIndex`	Boolean	True if the landing page is hidden from search engine indexing.
`vanityUrlPath`	String	The unique path for the asset, used to create the vanity URL.
`scriptFragment`	String	The script specified for a landing page using a stock template. This field isn’t queryable.
`redirectLocation`	String	The redirect URL used if the prospect is redirected instead of showing the thank you content.
`trackerDomainId`	Integer	ID of the tracker domain associated with this object.
`archiveDate`	Date	The landing page's archive date('yyyy-mm-dd').
`content`	String	The editable content if using a stock template. This field isn’t queryable.
`openingGeneralContent`	String	If using a layout template without `pardot-region` attributes, this value is displayed in the `%%form-opening-general-content%%` tag. More info. This field isn’t queryable.
`regionContent`	String	If using a layout template that contains pardot-region attributes, the values here override the default values in the layout template. For default values in the layout template, see Layout Template. This field isn’t queryable.

Field	Type	Description
`id`	Integer	ID of the object.
`salesforceId`	String	Salesforce Id of the object.
`isDeleted`	Boolean	True if the object is in the recycle bin in Account Engagement.
`createdById`	Integer	ID of the user who created this object.
`createdAt`	DateTime	Creation time of the object.
`updatedAt`	DateTime	Last update time of the object.
`updatedById`	Integer	ID of the user who last updated this object.
`layoutType`	Enum	Specifies where the landing page was created. See Landing Page Layout Type Enum.
`layoutCss`	String	The CSS code for the layout template. This field isn’t queryable.
`layoutCssGenerated`	String	The generated CSS code for the layout template. This field isn’t queryable.
`layoutTableBorder`	Integer	Specifies the layout table border width.
`isUseRedirectLocation`	Boolean	True if the prospect is redirected instead of showing the form thank you content.
`bitlyIsPersonalized`	Boolean	True if the object has a bitly URL that is personalized.
`bitlyShortUrl`	String	The bit.ly URL of the landing page, if present.
`url`	String	The link for the landing page.
`vanityUrl`	String	The vanity URL of the landing page, if present.
`layoutTemplate`	Layout Template	Layout Template object representing the layout template associated with the landing page. See the documentation for Layout Template for fields.
`form`	Form	Form object representing the form associated with the landing page. See the documentation for Form for fields.
`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.
`trackerDomain`	TrackerDomain	Tracker Domain object representing the tracker domain that was set on Create. See documentation for Tracker Domain for fields. A `null` value indicates that the object uses the default tracker domain for the account.
`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.
`salesforceCmsId`	String	The ID of the copied landing page when using `copyToCms`. If the landing page isn't successfully copied, the value is `null`.

Learn more about region in Control Which Landing Page Content Users Can Change.
The value for regionContent is a comma-separated enumeration of the regions. It follows this format, where regionName is the value of the pardot-region attribute to the HTML element defined in the layout template.

The fields for each region change depending on the type of region.

Field Name	Data Type	Region Type
alt	String	Image
height	String	Image
width	String	Image
src	String	Image
href	String	Link
target	String	Link
content	String	HTML Simple Basic WYSIWYG None

A Landing Page POST request must have a JSON body with all of the required fields specified. HTML content in the request must be escaped.

The content field is optional and doesn't provide the layoutTemplateId field.

Example request:

Example response:

This example doesn't show all the headers. Whitespace has been added to make it easier to read.

The layoutTemplateId field is required and the openingGeneralContent field is optional.

Example request:

Example response:

This example doesn't show all the headers. Whitespace has been added to make it easier to read.

The layoutTemplateId field is required and the regionContent field is optional.

Example request:

Example response:

This example doesn't show all the headers. Whitespace has been added to make it easier to read.

Examples include extra spaces for readability and don't always include headers. The fields in the response body and Location header match the fields specified on the example request.

Retrieve a single landing page following the conventions described in the Version 5 Overview.

Example request:

Example response:

Retrieving a collection of landing pages follows the conventions described in Version 5 Overview.

Example request:

Example response:

When executing a query, these fields can be specified. See the conventions for query described in the Version 5 Overview.

id
createdAt
updatedAt

When executing a query, these parameters are used to filter the returned results. These parameters are 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 landing pages where ID is equal to the given integer value.
`idList`	Returns any landing pages where ID is included in the given list of values.
`idGreaterThan`	Returns any landing pages where ID is greater than the specified value, non-inclusive.
`idGreaterThanOrEqualTo`	Returns any landing pages where the ID is greater than or equal to the specified value.
`idLessThan`	Returns any landing pages where ID is less than the specified value, non-inclusive.
`idLessThanOrEqualTo`	Returns any landing pages where the ID is less than or equal to the specified value.
`name`	Returns any landing pages where Name is equal to the given string value.
`createdAt`	Returns any landing pages where CreatedAt is equal to the given datetime value.
`createdAtAfter`	Returns any landing pages where CreatedAt is after the given datetime value, non-inclusive.
`createdAtAfterOrEqualTo`	Returns any landing pages where CreatedAt is after or equal to the given datetime value.
`createdAtBefore`	Returns any landing pages where CreatedAt is before the given datetime value, non-inclusive.
`createdAtBeforeOrEqualTo`	Returns any landing pages where CreatedAt is before or equal to the given datetime value.
`updatedAt`	Returns any landing pages where UpdatedAt is equal to the given datetime value.
`updatedAtAfter`	Returns any landing pages where UpdatedAt is after the given datetime value, non-inclusive.
`updatedAtAfterOrEqualTo`	Returns any landing pages where UpdatedAt is after or equal to the given datetime value.
`updatedAtBefore`	Returns any landing pages where UpdatedAt is before the given datetime value, non-inclusive.
`updatedAtBeforeOrEqualTo`	Returns any landing pages where UpdatedAt is before or equal to the given datetime value.
`layoutType`	Returns any landing pages where LayoutType is equal to the given string value.
`deleted`	Determines whether to return deleted records. The value can be `false` (default), `true`, or `all`.

Example request:

Example response:

Adds a Tag to the Landing Page object, which creates a TaggedObject.

Example Request

Example Response

Remove a tag from a Landing Page object. When you remove a tag, the associated TaggedObject record is deleted.

Example Request

Example Response

Returns code 204 no content.

Copy a landing page to your Salesforce CMS Marketing workspace.

Example Request

Example Response

Layout Template : The builder for classic landing page with a layout template.
Landing Page Builder : The builder for classic landing page with a preformatted stock template.
Legacy Page Builder : The legacy builder.
Salesforce Builder : The builder for enhanced landing page experience.