Update a contact list

Last updated December 30, 2019

POST /contacts/v1/lists/:list_id

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

contacts

This endpoint is used to update a list in a given HubSpot account.

Use case for this endpoint: If an external interface is used to build contact list filters, changes made there could be reflected in HubSpot via the update a contact list endpoint.

Like when creating a list, users will be able to edit and even delete these lists inside of the HubSpot UI.

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 you're looking for.
Optional parameters How to use Description
List name Used in the request body JSON Include 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

Response details

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.

  • 200 when a list is successfully updated.
  • 400 when there is a problem with the form data. You'll receive a JSON formatted response with a message that provides more details.
  • 500 when an internal server error occurs. Please alert us in the API Forum if you receive an HTTP 500 error.

These code samples use a demo API key. Using this key for anything but GET requests will result in an error. For all other requests (such as POST or PUT), you'll need to use your own API key or OAuth. For more details, please see here

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Exmaple URL: https://api.hubapi.com/contacts/v1/lists/226418?hapikey=demo Example request JSON: { "name": "tweeters", "filters": [ [ { "operator": "IS_EMPTY", "property": "twitterhandle", "type": "string" } ] ] } Example response: { "dynamic": true, "metaData": { "processing": "REFRESHING", "size": 0, "error": "", "lastProcessingStateChangeAt": 1479492156031, "lastSizeChangeAt": 0 }, "name": "tweeters", "filters": [ [ { "filterFamily": "PropertyValue", "withinTimeMode": "PAST", "type": "string", "property": "twitterhandle", "operator": "IS_EMPTY" } ] ], "portalId": 62515, "createdAt": 1479491992162, "listId": 226418, "updatedAt": 1479492156031, "authorId": 100097, "listType": "DYNAMIC", "internalListId": 227038 }
import requests import json url= 'https://api.hubapi.com/contacts/v1/lists/515844?hapikey=demo' headers = {} headers["Content-Type"]="application/json" data= json.dumps({ "name": "tweeters", "filters": [ [ { "operator": "IS_EMPTY", "property": "twitterhandle", "type": "string" } ] ] }) r= requests.get(url=url, headers=headers, data = data) print(r.text)
var request = require("request"); var options = { method: 'POST', url: 'https://api.hubapi.com/contacts/v1/lists/515844', qs: { hapikey: 'demo' }, headers: { 'Content-Type': 'application/json' }, body: { name: 'TestListDynamic', filters: [ [ { operator: 'IS_EMPTY', property: 'twitterhandle', type: 'string' } ] ] }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });