Form Handler Object

Form handlers are an alternative to Pardot forms. You can use a form handler to integrate your third-party or custom forms with Pardot to track submission data. Learn more about form handlers in Salesforce Help.

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

OperationHTTP VerbURL FormatAbility Requirements
CreatePOSThttps://pi.pardot.com/api/v5/objects/form-handlersForms > Form Handlers > Create ability
ReadGEThttps://pi.pardot.com/api/v5/objects/form-handlers/<id>?<params>Forms > Form Handlers > View ability
UpdatePATCHhttps://pi.pardot.com/api/v5/objects/form-handlers/<id>Forms > Form Handlers > Create ability
DeleteDELETEhttps://pi.pardot.com/api/v5/objects/form-handlers/<id>Forms > Form Handlers > Delete ability
QueryGEThttps://pi.pardot.com/api/v5/objects/form-handlers?<params>Forms > Form Handlers > View ability

Required Editable Fields

These fields are required only for the create operation.

FieldTypeDescription
nameStringName of the object for identification in Pardot.
folderIdIntID of the folder containing this object.
campaignIdIntThe ID of the campaign associated with this object.

Optional Editable Fields

FieldTypeDescription
trackerDomainIdIntegerThe ID of the tracker domain associated with this object.
isDataForwardedBooleanWhen true, enables data forwarding to the success location.
sucessLocationStringThe URL the user is forwarded to if the submission is successful.
errorLocationStringThe URL the user is forwarded to if the submission has an error.
isAlwaysEmailBooleanWhen true, disables visitor activity throttling and sends autoresponder emails after every submission. Learn more about throttling in Salesforce Help.
isCookielessBooleanWhen true, the form handler is in Kiosk/Data Entry Mode, and does not cookie browser as a submitted prospect.

Read-Only Fields

FieldTypeDescription
idIntID of this object.
salesforceIdStringSalesforce Id of the object.
embedCodeStringCode to embed this form handler in a webpage.
createdAtDateTimeCreation time of this object.
updatedAtDateTimeLast updated time for the object.
createdByIdIntID of the user who created the object.
isDeletedBooleanTrue if the object is in the Pardot recycle bin.
updatedByIdIntID of the user who last updated the object.
createdByUserUser object representing the user who created the object. See documentation for User for fields.
updatedByUserUser object representing the user who last updated the 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 form handler. See documentation for Tracker Domain for fields.

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

When form handlers are created, an email field is included automatically.

Example request:

Example response:

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

Example request:

Example Response

Updating a form handler follows the conventions described in the Version 5 Overview.

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

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

Sortable Fields

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

  • id
  • createdAt
  • updatedAt

Example Request

Example Response

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.

ParameterDescription
idReturns any form handler where ID is equal to the given integer value.
idGreaterThanReturns any form handler where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any form handler where ID is greater than or equal to the specified value.
idLessThanReturns any form handler where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any form handler where ID is less than or equal to the specified value.
createdAtReturns any form handler where CreatedAt is equal to the given datetime value.
createdAtAfterReturns any form handler where CreatedAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any form handler where CreatedAt is after or equal to the given datetime value.
createdAtBeforeReturns any form handler where CreatedAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any form handler where CreatedAt is before or equal to the given datetime value.
updatedAtReturns any form handler where UpdatedAt is equal to the given datetime value.
updatedAtAfterReturns any form handler where UpdatedAt is after the given datetime value, non-inclusive.
updatedAtAfterOrEqualToReturns any form handler where UpdatedAt is after or equal to the given datetime value.
updatedAtBeforeReturns any form handler where UpdatedAt is before the given datetime value, non-inclusive.
updatedAtBeforeOrEqualToReturns any form handler 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