Basic

Partially update a form definition

Update an existing form in your HubSpot account by specifying the form ID. This operation allows you to modify the form's properties, such as its name, field groups, configuration, display options, legal consent options, and archived status. This is useful for keeping forms up to date with your current marketing strategies or compliance requirements.

patch/marketing/forms/2027-03-beta/{formId}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/marketing/forms/2027-03-beta/{formId}
  • Auth
    OAuth 2
    Authorization code: https://app.hubspot.com/oauth/authorize
    Token URL: https://api.hubapi.com/oauth/v1/token scopes: forms

Path parameters

formIdstring required

Request body

archivedboolean

Whether this form is archived.

namestring

The name of the form. Expected to be unique for a hub.

Response

successful operation

archivedboolean required
archivedAtstring date-time
createdAtstring date-time required
formType'hubspot' required
idstring required
namestring required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.