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 |
|---|---|---|---|
| Create | POST | https://pi.pardot.com/api/v5/objects/forms | Marketing > Forms > Forms > Create |
| Read | GET | https://pi.pardot.com/api/v5/objects/forms/<id>?<params> | Marketing > Forms > Forms > View |
| Query | GET | https://pi.pardot.com/api/v5/objects/forms?<params> | Marketing > Forms > Forms > View |
| Delete | DELETE | https://pi.pardot.com/api/v5/objects/forms/<id> | Marketing > Forms > Forms > Delete |
| 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 |
| Add Tag | POST | https://pi.pardot.com/api/v5/objects/forms/<id>/do/addTag | Marketing > Forms > Forms > Create AND Marketing > Segmentation > Tags > Create |
| Remove Tag | POST | https://pi.pardot.com/api/v5/objects/forms/<id>/do/removeTag | Marketing > Forms > Forms > Create AND Marketing > Segmentation > Tags > Create |
| Field | Type | Description |
|---|---|---|
name | String | The name of the object for identification in Account Engagement. |
campaignId | Integer | The ID of the campaign related to this object. |
layoutTemplateId | Integer | The ID of the layout template related to this object. |
| Field | Type | Description |
|---|---|---|
folderId | Integer | The ID of the folder containing this object. |
trackerDomainId | Integer | The ID of the tracker domain related to this object. |
submitButtonText | String | The label used for the submit button. |
beforeFormContent | String | The HTML text displayed above the form. |
afterFormContent | String | The HTML text displayed below the form. |
thankYouContent | String | The HTML text displayed after the form is submitted. |
thankYouCode | String | Thank you code is typically Javascript used to call other systems like Google Conversion Tracking. |
isAlwaysDisplay | Boolean | Always display form after submission. Disable the 10 minute waiting period after submitting a form. |
redirectLocation | String | Redirect to this URL instead of showing the "thank you" content. |
fontSize | String | Possible values: default, 8pt, 10pt, 12pt, 14pt , 18pt, 24pt, 36pt. |
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". |
fontColor | String | 6 digit number in hexadecimal format such as #123456. |
labelAlignment | String | Possible values: default, above, left. |
radioAlignment | String | Possible values: default, horizontal, stacked. |
checkboxAlignment | String | Possible values: default, horizontal, stacked. |
requiredCharacter | String | Possible values: default, *. |
isCookieless | Boolean | Kiosk/Data Entry Mode: Do not cookie browser as submitted prospect. |
showNotProspect | Boolean | Include "Not you?" link to allow visitors to reset the form. Valid when isCookieless isn’t set. |
isCaptchaEnabled | Boolean | Enable explicit bot protection using reCAPTCHA. |
| Field | Type | Description |
|---|---|---|
id | Integer | The ID of the object. |
embedCode | String | The HTML code to embed this form in an iframe. |
salesforceId | String | Salesforce Id of the object. |
isUseRedirectLocation | Boolean | When redirect location is valid and enabled. |
isDeleted | Boolean | True if the object is in the recycle bin in Account Engagement. |
createdById | Integer | The ID of the user who created this object. |
updatedById | Integer | The ID of the user who last updated this object. |
createdAt | DateTime | Date and time that the object was created. |
updatedAt | DateTime | Date and time that the object was updated. |
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. |
layoutTemplate | LayoutTemplate | Layout Template object representing the layout template related to this object. See documentation for Layout Template for fields. |
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. |
campaign | Campaign | Campaign object representing the campaign related to this object. See documentation for Campaign for fields. |
folder | Folder | Folder object representing the folder containing this object. See documentation for Folder for fields. |
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, the following fields can be specified. See the conventions for query described in the Version 5 Overview.
id
Example request:
Example response:
When executing a query, the following 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 |
|---|---|
id | Returns any forms where ID is equal to the given integer value. |
idList | Returns any forms where ID is included in the given list of values. |
idGreaterThan | Returns any forms where ID is greater than the specified value, non-inclusive. |
idGreaterThanOrEqualTo | Returns any forms where ID is greater than or equal to the specified value. |
idLessThan | Returns any forms where ID is less than the specified value, non-inclusive. |
idLessThanOrEqualTo | Returns any forms where ID is less than or equal to the specified value. |
name | Returns any forms where Name 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:
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.
- 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
*