Update an existing form

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

For a given portal, update an existing form in a given HubSpot portal. Forms are standard website forms that can be used to generate website leads.

For any form, there may be a set of fields associated with that form in question. You can specify all of the fields that you'd like to be a part of any form that you're updating with this API call.

You should also note that if you attempt to create a form with the same name as one that already exists, we will return a 409, as all forms should have a unique name.

Required Parameters	How to use	Description
OAuth access token or private app access token	Authorization: Bearer {token} header	Used to authenticate the request. Please see this page for more details about authentication.
Form GUID	Used in the request URL	The unique ID fo the form that you're updating. When updating a form, you need to explicitly specify which form you're updating, which is what this field is for.
Form Data to Update	Used in the request body	The data for the form that you're creating. This can include any number of data points, including fields. For an example of this data, please see the JSON code sample for POSTing and creating a new form below.

Optional Parameters	How to use	Description
Form Fields	Used in the request body	When updating a form, you have the ability to also manipulate any of the form fields that you'd like to be a part of the form you're updating. Please note however, that if you specify fields in this call, it will override the fields that have already been set on this form. For instance, in the request that you see below, "Favorite Color" will now be the only field in the form, rather than being appended to the rest of the fields that already exist there. Before adding a field to a form, you'll need to make sure that there's a corresponding contact property. You can create a new property to house any fields with the create property method.

Example URL: https://api.hubapi.com/forms/v2/forms/561d9ce9-bb4c-45b4-8e32-21cdeaa3a7f0

The response from this API call are standard REST-style HTTP response codes that mark success or failure, along with the JSON representing the form that you just updated. See below for a sample of this JSON output.

200 when a form is updated.
401 when an unauthorized request is made.
500 when an internal server error occurs.

JSON

Developers

Update an existing form

PUT /forms/v2/forms/:form_guid

Method Details

About

Jobs

Learn Inbound

Support

Locations