Formspree recognizes certain inputs with special names, and uses them to control the behavior of plugins and notifications. Here's a list of all the Formspree special fields, along with the behaviors they control.
address
| Field Name |
address |
| Type |
text |
| Used By |
hubspot, mailchimp |
| Description |
The address of the new contact or lead. |
company
email
| Field Name |
email |
| Type |
email address |
| Used By |
Email notifications, autoresponse, freshdesk, gladly, gorgias, hubspot, mailchimp, mailerlite, pipedrive, zendesk |
| Description |
The email address of the person submitting the form. For submission notifications, this will be used in the Reply-To header. For newsletter or CRM plugins, it will set the primary email address of the contact. See also the help article on setting the Reply To address. |
message
| Field Name |
message, msg |
| Type |
text |
| Used By |
gladly, gorgias, hubspot, trello, freshdesk, zendesk |
| Description |
The message or main text area of the form. For support center plugins like Zendesk, it will set the body of the ticket, however all other fields will also be included in the ticket below the message body. |
name
| Field Name |
name, firstName, lastName |
| Type |
text |
| Used By |
freshdesk, gorgias, hubspot, mailchimp, mailerlite, pipedrive, zendesk |
| Description |
The name of the person submitting the form. Certain plugins like Mailchimp have separate first name and last name fields. For these plugins, if the name field contains two words, it will be split into first and last names. For more control, you can use the firstName and lastName special fields instead to explicitly set the first and last names, respectively. |
_optin
| Field Name |
_optin |
| Type |
checkbox / boolean |
| Used By |
mailchimp, mailerlite |
| Description |
If a newsletter plugin is configured to use the _optin field, new contacts will only be added to the newsletter when this field is set in the submission. |
phone
_price
| Field Name |
_price |
| Type |
number |
| Used By |
stripe |
| Description |
If the stripe plugin is configured to accept a variable price, the _price field will determine the amount of the charge. See the help article on Stripe. |
priority
| Field Name |
priority |
| Type |
one of "low", "medium", "high" or "urgent" |
| Used By |
freshdesk, zendesk |
| Description |
For help desk plugins, sets the priority of the new ticket. |
subject
| Field Name |
subject |
| Type |
text |
| Used By |
Email notifications, discord, freshdesk, gorgias, pipedrive, slack, telegram, trello, zendesk |
| Description |
The subject or topic of the message. For submission notifications, this will be used in the Subject header. Note: this should probably be a hidden or select input, not free text. See the help article on setting the Subject. |
tags
| Field Name |
tags |
| Type |
a comma separated list of tag names |
| Used By |
freshdesk, gorgias, pipedrive, mailchimp, zendesk |
| Description |
For help desk plugins, adds a list of tags to the ticket. Typically this should be a hidden field, or controlled by a select input. |
urgent
| Field Name |
urgent |
| Type |
checkbox / boolean |
| Used By |
freshdesk, zendesk |
| Description |
For help desk plugins, sets the priority of the new ticket to "urgent". |
value
| Field Name |
value |
| Type |
number |
| Used By |
pipedrive |
| Description |
The value of the new contact or lead. Currency will be determined by the attached plugin. |