Form Handler Field Object

Form handlers are an alternative to Pardot forms. Form handlers contain form handler fields to gather information from prospects. 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 Field object follows the conventions described in Version 5 Overview.

OperationHTTP VerbURL FormatAbility Requirements
CreatePOSThttps://pi.pardot.com/api/v5/objects/form-handler-fieldsForms > Form Handlers > Create ability
ReadGEThttps://pi.pardot.com/api/v5/objects/form-handler-fields/<id>?<params>Forms > Form Handlers > View ability
UpdatePATCHhttps://pi.pardot.com/api/v5/objects/form-handler-fields/<id>Forms > Form Handlers > Create ability
DeleteDELETEhttps://pi.pardot.com/api/v5/objects/form-handler-fields/<id>Forms > Form Handlers > Delete ability
QueryGEThttps://pi.pardot.com/api/v5/objects/form-handler-fields?<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.
formHandlerIdIntegerThe ID of the form handler this field belongs to.
isRequiredBooleanWhen true, the field is required.
dataFormatEnumThe field's data format. Values are "text", "number","email", "email not from isps and free email providers", and "email with valid mail server".
prospectApiFieldIdStringThe name of the Pardot prospect field that the form handler field 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".

Optional Editable Fields

FieldTypeDescription
isMaintainInitialValueBooleanWhen true, the field maintains the initial value upon subsequent form submissions.
errorMessageStringError message for the field.

Read-Only Fields

FieldTypeDescription
idIntID of this object.
createdAtDateTimeCreation time of this object.
updatedAtDateTimeLast updated time for the object.
createdByIdIntID of the user who created the object.
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.

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

Example request:

Example response:

201 Created

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

Example request:

Example Response

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

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

Retrieving a collection of form handler fields 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
  • formHandlerId

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
formHandlerIdReturns any form handler field where formHandlerId is equal to the given integer.
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 field where CreatedAt is equal to the given datetime value.
createdAtAfterReturns any form handler field where CreatedAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any form handler field where CreatedAt is after or equal to the given datetime value.
createdAtBeforeReturns any form handler field where CreatedAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any form handler field where CreatedAt is before or equal to the given datetime value.
updatedAtReturns any form handler field where UpdatedAt is equal to the given datetime value.
updatedAtAfterReturns any form handler field where UpdatedAt is after the given datetime value, non-inclusive.
updatedAtAfterOrEqualToReturns any form handler field where UpdatedAt is after or equal to the given datetime value.
updatedAtBeforeReturns any form handler field where UpdatedAt is before the given datetime value, non-inclusive.
updatedAtBeforeOrEqualToReturns any form handler field where UpdatedAt is before or equal to the given datetime value.

Example Request

Example Response