Form Handler Field Object
Form handlers are an alternative to Account Engagement 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 Account Engagement 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.
| Operation | HTTP Verb | URL Format | Ability Requirements |
|---|---|---|---|
| Create | POST | https://pi.pardot.com/api/v5/objects/form-handler-fields | Forms > Form Handlers > Create ability |
| Read | GET | https://pi.pardot.com/api/v5/objects/form-handler-fields/<id>?<params> | Forms > Form Handlers > View ability |
| Update | PATCH | https://pi.pardot.com/api/v5/objects/form-handler-fields/<id> | Forms > Form Handlers > Create ability |
| Delete | DELETE | https://pi.pardot.com/api/v5/objects/form-handler-fields/<id> | Forms > Form Handlers > Delete ability |
| Query | GET | https://pi.pardot.com/api/v5/objects/form-handler-fields?<params> | Forms > Form Handlers > View ability |
These fields are required only for the create operation.
| Field | Type | Description |
|---|---|---|
name | String | Name of the object for identification in Account Engagement. |
formHandlerId | Integer | The ID of the form handler this field belongs to. |
dataFormat | Enum | The field's data format. Values are "text", "number","email", "email not from isps and free email providers", and "email with valid mail server". |
prospectApiFieldId | String | The name of the Account Engagement 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". |
| Field | Type | Description |
|---|---|---|
isMaintainInitialValue | Boolean | When true, the field maintains the initial value upon subsequent form submissions. |
errorMessage | String | Error message for the field. If isRequired is true, and errorMessage is not provided, it assumes a default value: This field is required. |
isRequired | Boolean | Defaults to false. When true, the field will be required for a valid submission of the form handler. |
| Field | Type | Description |
|---|---|---|
id | Integer | ID of this object. |
createdAt | DateTime | Creation time of this object. |
createdById | Integer | ID of the user who created the object. |
createdBy | User | User object representing the user who created the object. See documentation for User for fields. |
formHandler | Form Handler | Form Handler object that the field belongs to. See documentation for Form Handler 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.
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.
idcreatedAtformHandlerId
Example Request
Example Response
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.
| Parameter | Description |
|---|---|
id | Returns any form handler field where ID is equal to the given integer value. |
idList | Returns any form handler field where ID is included in the given list of values. |
idGreaterThan | Returns any form handler field where ID is greater than the specified value, non-inclusive. |
idGreaterThanOrEqualTo | Returns any form handler field where ID is greater than or equal to the specified value. |
idLessThan | Returns any form handler field where ID is less than the specified value, non-inclusive. |
idLessThanOrEqualTo | Returns any form handler field where ID is less than or equal to the specified value. |
formHandlerId | Returns any form handler field where formHandlerId is equal to the given integer. |
createdAt | Returns any form handler field where CreatedAt is equal to the given datetime value. |
createdAtAfter | Returns any form handler field where CreatedAt is after the given datetime value, non-inclusive. |
createdAtAfterOrEqualTo | Returns any form handler field where CreatedAt is after or equal to the given datetime value. |
createdAtBefore | Returns any form handler field where CreatedAt is before the given datetime value, non-inclusive. |
createdAtBeforeOrEqualTo | Returns any form handler field where CreatedAt is before or equal to the given datetime value. |
Example Request
Example Response