Submit data to a form (supporting authentication)

curl --request POST \
  --url https://api.hsforms.com/submissions/v3/integration/secure/submit/{portalId}/{formGuid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": [
    {
      "objectTypeId": "<string>",
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "submittedAt": "<string>",
  "context": {
    "hutk": "<string>",
    "ipAddress": "<string>",
    "pageName": "<string>",
    "pageUri": "<string>",
    "pageId": "<string>",
    "sfdcCampaignId": "<string>",
    "goToWebinarWebinarKey": "<string>"
  },
  "legalConsentOptions": {
    "consent": {
      "consentToProcess": true,
      "text": "<string>",
      "communications": [
        {
          "value": true,
          "subscriptionTypeId": 123,
          "text": "<string>"
        }
      ]
    },
    "legitimateInterest": {
      "value": true,
      "subscriptionTypeId": 123,
      "legalBasis": "CUSTOMER",
      "text": "<string>"
    }
  },
  "skipValidation": true
}
'

{
  "redirectUri": "<string>",
  "inlineMessage": "<string>"
}

POST

submissions

integration

secure

submit

{portalId}

{formGuid}

Submit data to a form (supporting authentication)

curl --request POST \
  --url https://api.hsforms.com/submissions/v3/integration/secure/submit/{portalId}/{formGuid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": [
    {
      "objectTypeId": "<string>",
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "submittedAt": "<string>",
  "context": {
    "hutk": "<string>",
    "ipAddress": "<string>",
    "pageName": "<string>",
    "pageUri": "<string>",
    "pageId": "<string>",
    "sfdcCampaignId": "<string>",
    "goToWebinarWebinarKey": "<string>"
  },
  "legalConsentOptions": {
    "consent": {
      "consentToProcess": true,
      "text": "<string>",
      "communications": [
        {
          "value": true,
          "subscriptionTypeId": 123,
          "text": "<string>"
        }
      ]
    },
    "legitimateInterest": {
      "value": true,
      "subscriptionTypeId": 123,
      "legalBasis": "CUSTOMER",
      "text": "<string>"
    }
  },
  "skipValidation": true
}
'

{
  "redirectUri": "<string>",
  "inlineMessage": "<string>"
}

Required Scopes

This API requires one of the following scopes:

forms

Path Parameters

portalId

string

required

The HubSpot portal the form belongs to.

formGuid

string

required

The ID of the form you're sending data to.

Body

application/json

fields

object[]

required

A list of form field names and the values for those fields, up to 1000 fields can be included.

Maximum array length: 1000

Show child attributes

fields.objectTypeId

string

required

The object type ID (e.g., '0-1' for contacts, '0-2' for companies)

fields.name

string

required

The name of the field

fields.value

string

required

The value for the field

submittedAt

string

A millisecond timestamp representing the time of the form submission. This can be used to backdate the submission, but using a time more than one month old will result in an error.

context

object

Show child attributes

context.hutk

string

The tracking cookie token value used for HubSpot lead activity tracking.

context.ipAddress

string

The IP address of the visitor filling out the form.

context.pageName

string

The name or title of the page the submission happened on.

context.pageUri

string

The URI of the page the submission happened on.

context.pageId

string

The ID of a page created on the HubSpot CMS.

context.sfdcCampaignId

string

If the form is for an account using the HubSpot Salesforce Integration, you can include the ID of a Salesforce campaign.

context.goToWebinarWebinarKey

string

If the form is for an account using the HubSpot GoToWebinar Integration, you can include the ID of a webinar.

Show child attributes

Whether or not the visitor checked the Consent to process checkbox

The text displayed to the visitor for the Consent to process checkbox

Show child attributes

Whether or not the visitor checked the checkbox for this subscription type

The ID of the specific subscription type

The text displayed to the visitor for this specific subscription checkbox

Show child attributes

This must be true when using the 'legitimateInterest' option

The ID of the specific subscription type that this forms indicates interest to

Whether this form indicates legitimate interest from a prospect/lead or from a client

Available options:

CUSTOMER,

LEAD

The privacy text displayed to the visitor

skipValidation

boolean

deprecated

Whether or not to skip validation based on the form settings. Defaults to false. Note: This parameter is deprecated.

Response

Form submission successful

redirectUri

string

If the submission was accepted, and the form has a redirect URI set in its settings, this will be that redirect URI

inlineMessage

string

If the submission was accepted, and the form has an inline thank you message set in its settings, this will be the HTML for that message

​Required Scopes

Path Parameters

Body

Response

Required Scopes