Form Object

Use forms to collect visitor information and create identified prospects. Learn more about forms in Salesforce Help.

The API to access the Form object collection follows the conventions described in Version 5 Overview.

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

Operation	HTTP Verb	URL Format	Ability Requirements
Add Tag	`POST`	`https://pi.pardot.com/api/v5/objects/forms/<id>/do/addTag`	Marketing > Forms > Forms > Create AND Marketing > Segmentation > Tags > Create
Copy to CMS	`POST`	`https://pi.pardot.com/api/v5/objects/forms/<id>/do/copyToCms`	Marketing > Forms > Forms > Copy to CMS
Create	`POST`	`https://pi.pardot.com/api/v5/objects/forms`	Marketing > Forms > Forms > Create
Delete	`DELETE`	`https://pi.pardot.com/api/v5/objects/forms/<id>`	Marketing > Forms > Forms > Delete
Query	`GET`	`https://pi.pardot.com/api/v5/objects/forms?<params>`	Marketing > Forms > Forms > View
Read	`GET`	`https://pi.pardot.com/api/v5/objects/forms/<id>?<params>`	Marketing > Forms > Forms > View
Remove Tag	`POST`	`https://pi.pardot.com/api/v5/objects/forms/<id>/do/removeTag`	Marketing > Forms > Forms > Create AND Marketing > Segmentation > Tags > Create
Reorder Form Fields	`POST`	`https://pi.pardot.com/api/v5/objects/forms/<id>/do/reorderFormFields`	Marketing > Forms > Forms > Create
Undelete	`POST`	`https://pi.pardot.com/api/v5/objects/forms/do/undelete`	Marketing > Forms > Forms > Delete

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

Field	Type	Description
`afterFormContent`	String	The HTML text displayed below the form.
`beforeFormContent`	String	The HTML text displayed above the form.
`checkboxAlignment`	String	Possible values: default, horizontal, stacked.
`folderId`	Integer	The ID of the folder containing this object.
`fontColor`	String	6-digit number in hexadecimal format such as #123456.
`fontFamily`	String	Possible values: default, "Helvetica, Arial, Sans-serif", "Georgia, Times, Times New Roman, Serif", "Tahoma, Trebuchet MS, Verdana, Helvetica, Arial, Sans-serif", "Courier New, Courier, Monospace".
`fontSize`	String	Possible values: default, 8pt, 10pt, 12pt, 14pt, 18pt, 24pt, 36pt.
`isAlwaysDisplay`	Boolean	Always display the form after submission. When enabled, the form displays after submission. When disabled, a 10-minute waiting period hides the form after submission.
`isCaptchaEnabled`	Boolean	Enable explicit bot protection using reCAPTCHA.
`isCookieless`	Boolean	Kiosk/Data Entry Mode: Don't use browser cookies to create prospects.
`labelAlignment`	String	Possible values: default, above, left.
`radioAlignment`	String	Possible values: default, horizontal, stacked.
`redirectLocation`	String	Redirect to this URL instead of showing the "thank you" content.
`requiredCharacter`	String	Possible values: default, *.
`showNotProspect`	Boolean	Include "Not you?" link to allow visitors to reset the form. Valid when `isCookieless` isn't set.
`submitButtonText`	String	The label used for the submit button.
`thankYouCode`	String	Thank you code is typically JavaScript used to call other systems like Google Conversion Tracking.
`thankYouContent`	String	The HTML text displayed after the form is submitted.
`trackerDomainId`	Integer	The ID of the tracker domain related to this object.

Field	Type	Description
`campaign`	Campaign	Campaign object representing the campaign related to this object. See documentation for Campaign for fields.
`createdAt`	DateTime	Date and time that the object was created.
`createdBy`	User	User object representing the user who created this object. See documentation for User for fields.
`createdById`	Integer	The ID of the user who created this object.
`embedCode`	String	The HTML code to embed this form in an iframe.
`folder`	Folder	Folder object representing the folder containing this object. See documentation for Folder for fields.
`id`	Integer	The ID of the object.
`isDeleted`	Boolean	This value is `true` if the object is in the recycle bin in Account Engagement.
`isUseRedirectLocation`	Boolean	This value is `true` when the redirect location is valid and enabled.
`layoutTemplate`	LayoutTemplate	Layout Template object representing the layout template related to this object. See documentation for Layout Template for fields.
`salesforceCmsId`	String	The ID of the copied form when using `copyToCms`. If the form isn't successfully copied, the value is `null`.
`salesforceId`	String	Salesforce ID of the object.
`trackerDomain`	TrackerDomain	Tracker Domain object representing the tracker domain related to this object. See documentation for Tracker Domain for fields. A `null` value indicates that the object uses the default tracker domain for the account.
`updatedAt`	DateTime	Date and time that the object was updated.
`updatedBy`	User	User object representing the user who last updated this object. See documentation for User for fields.
`updatedById`	Integer	The ID of the user who last updated this object.
`url`	String	The URL of the form.

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

Example Request:

Example response:

201 Created

Retrieve a single form object following the conventions described in the Version 5 Overview.

Example request:

Example response:

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

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

id

Example request:

Example response:

When executing a query, these parameters are 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
`deleted`	Determines whether to return deleted records. The value can be `false` (default), `true`, or `all`.
`id`	Returns any forms where the ID is equal to the given integer value.
`idGreaterThan`	Returns any forms where the ID is greater than the specified value, non-inclusive.
`idGreaterThanOrEqualTo`	Returns any forms where the ID is greater than or equal to the specified value.
`idLessThan`	Returns any forms where the ID is less than the specified value, non-inclusive.
`idLessThanOrEqualTo`	Returns any forms where the ID is less than or equal to the specified value.
`idList`	Returns any forms where the ID is included in the given list of values.
`name`	Returns any forms where Name is equal to the given string value.

Example request:

Example response:

Deleting a form follows the conventions described in the Version 5 Overview.

Restore a single form from the Account Engagement Recycle Bin.

Example Request

By Form ID

Example Response

Reorder a list of form fields for a given form, this changes a Form Fields sortOrder. When this action is taken, the new order of fields are seen when querying or reading Form Fields.

Example Request

Example Response

Adds a Tag to the Form object, which creates a TaggedObject.

Example Request

Example Response

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

Example Request

Example Response

Returns code 204 no content.

Copy a form to your Salesforce CMS Marketing workspace.

Example Request

Example Response

Default
8pt
10pt
12pt
14pt
18pt
24pt
36pt

Default
Helvetica
Arial
Tahoma
Trebuchet MS
Verdana
Sans-serif
Georgia
Times
Times New Roman
Serif
Courier New
Courier
Monospace

Default
Above
Left

Default
Horizontal
Stacked

Default
Horizontal
Stacked

Default
*