Represents a single submission of a website contact form, storing the visitor's details and message. It is linked to the website, branch and admin organisation it was received on, and optionally to the submitter's profile. Creating one via the contact form service triggers auto-response and notification emails, and drives lead and funnel tracking through the contact form submitted funnel event. Extra form fields not covered by the built-in properties are stored as name and value pairs and read back with fieldValue.

Group: Database Entities

Implements: Serializable, Relational


Properties

PropertyReturnsDescription
acknowledgedDateDateDate this contact request was acknowledged or actioned by an admin user, or null if it has not yet been acknowledged.
adminOrgOrganisationThe admin organisation that owns the website this contact request was submitted to. May be null on records migrated before this field was introduced.
attachmentsList<ContactRequestAttachment>Files uploaded with this contact form submission.
branchBranchThe branch of the website this contact request was received on.
companyStringCompany name entered by the submitter, up to 1024 characters. May be null.
contactFormStringPath or identifier of the contact form that was submitted, used to distinguish between multiple contact forms on the same website.
createdDateDateDate and time this contact request was received. Never null.
emailStringEmail address entered by the submitter, up to 1024 characters.
fieldsList<ContactRequestField>Extra form fields captured for this submission, beyond the built-in properties such as email and message. Set via addField and read back with fieldValue.
firstNameStringFirst name entered by the submitter, up to 1024 characters. May be null.
idlongUnique database identifier for this contact request.
messageStringFree-text message entered by the submitter, up to 100000 characters.
phoneStringPhone number entered by the submitter, up to 1024 characters. May be null.
profileProfileThe profile of the submitter, when the contact form was submitted by a logged-in or otherwise identified user. May be null for anonymous submissions.
sourceIpStringIP address the contact form submission was received from.
surNameStringSurname entered by the submitter, up to 1024 characters. May be null.
userAgentStringThe HTTP User-Agent header sent by the submitter's browser, up to 1024 characters. May be null.
websiteWebsiteThe website this contact request was submitted to.

Methods

getId() · getAdminOrg() · getCreatedDate() · getAcknowledgedDate() · getProfile() · getBranch() · getUserAgent() · getContactForm() · getSourceIp() · getWebsite() · getAttachments() · getFields() · getCompany() · getEmail() · getFirstName() · getPhone() · getSurName() · getMessage() · fieldValue(String name)

getId()

Returns: long

Unique database identifier for this contact request.

getAdminOrg()

Returns: Organisation

The admin organisation that owns the website this contact request was submitted to. May be null on records migrated before this field was introduced.

getCreatedDate()

Returns: Date

Date and time this contact request was received. Never null.

getAcknowledgedDate()

Returns: Date

Date this contact request was acknowledged or actioned by an admin user, or null if it has not yet been acknowledged.

getProfile()

Returns: Profile

The profile of the submitter, when the contact form was submitted by a logged-in or otherwise identified user. May be null for anonymous submissions.

getBranch()

Returns: Branch

The branch of the website this contact request was received on.

getUserAgent()

Returns: String

The HTTP User-Agent header sent by the submitter's browser, up to 1024 characters. May be null.

getContactForm()

Returns: String

Path or identifier of the contact form that was submitted, used to distinguish between multiple contact forms on the same website.

getSourceIp()

Returns: String

IP address the contact form submission was received from.

getWebsite()

Returns: Website

The website this contact request was submitted to.

getAttachments()

Returns: List<ContactRequestAttachment>

Files uploaded with this contact form submission.

getFields()

Returns: List<ContactRequestField>

Extra form fields captured for this submission, beyond the built-in properties such as email and message. Set via addField and read back with fieldValue.

getCompany()

Returns: String

Company name entered by the submitter, up to 1024 characters. May be null.

getEmail()

Returns: String

Email address entered by the submitter, up to 1024 characters.

getFirstName()

Returns: String

First name entered by the submitter, up to 1024 characters. May be null.

getPhone()

Returns: String

Phone number entered by the submitter, up to 1024 characters. May be null.

getSurName()

Returns: String

Surname entered by the submitter, up to 1024 characters. May be null.

getMessage()

Returns: String

Free-text message entered by the submitter, up to 100000 characters.

fieldValue(String name)

Returns: String

Looks up the value of one of this contact request's extra fields by name.

ParameterDescription
namethe name of the extra field to look up
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.