The ID of the layout template related to this object.
name
String
The name of the object for identification in Account Engagement.
Optional Editable Fields
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.
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.
1HTTP/1.1 200 OK2Content-Type: application/json3{4 "id": 101,5 "name": "Standard Form",6 "isDeleted": false,7 "thankYouContent": "<p>Thank you for filling out the form. We will get back to you shortly.</p>",8 "submitButtonText": "Submit",9 "campaign": {10 "name": "My Campaign"11},12 "createdAt": "2020-09-29T09:36:56-04:00",13 "updatedAt": "2020-09-29T09:36:56-04:00",14 "createdBy": {15 "username": "jsmith@example.com"16},17 "updatedBy": {18 "username": "jsmith@example.com"19}20}
Form Query
Retrieving a collection of forms follows the conventions described in Version 5 Overview.
Sortable Fields
When executing a query, these fields can be specified. See the conventions for query described in the Version 5 Overview.
1HTTP/1.1 200 OK2Content-Type: application/json3{4 "values": [5{6 "id": 101,7 "name": "Standard Form",8 "isDeleted": false,9 "thankYouContent": "<p>Thank you for filling out the form. We will get back to you shortly.</p>",10 "submitButtonText": "Submit",11 "campaign": {12 "name": "My Campaign"13},14 "createdAt": "2020-09-29T09:36:56-04:00",15 "updatedAt": "2020-09-29T09:36:56-04:00",16 "createdBy": {17 "username": "jsmith@example.com"18},19 "updatedBy": {20 "username": "jsmith@example.com"21}22}23]24}
Filtering Results
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.
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.
j