HTTP Methods:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
Update a list in a given HubSpot account.
Note that like creating a list, users will be able to edit and even delete these lists inside of the HubSpot user interface.
| Required Parameters | How to use | Description |
|---|---|---|
| OAuth Access Token or API Key | Authorization: Bearer {token} header or hapikey={key} query parameter. |
Used to authenticate the request. Please see this page for more details about authentication. |
| List ID | Used in the request URL | Unique identifier for the list that you're looking for. |
| Optional Parameters | How to use | Description |
|---|---|---|
| List Name | Used in the request body JSON | Include the name to update the name of the list. |
| Filters | Used in the request body JSON (see below) | Use filters to customize your list results. Find more details about available filters and how they work here. Note: Adding new filter data to the request will replace any existing filters. To append your filters, you must include the existing ones in a new request. |
| Other List data | Used in the request body JSON | See creating a list for other data that can be set. |
Example URL to POST to: https://api.hubapi.com/contacts/v1/lists/2?hapikey=demo
If the request succeeds, you'll get an HTTP 200 response with the updated data for the list, which represents that you have successfully refreshed the list in the system.
The response from this API call are standard REST-style HTTP response codes that mark success or failure, with meta information about the call that was made. If you've successfully updated the list, you will receive the updated list as a json object in the response body.
