Skip to main content
POST
/
contacts
/
v1
/
lists
Create a new contact list
curl --request POST \
  --url https://api.hubapi.com/contacts/v1/lists \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "dynamic": false,
  "filters": []
}
'
{
  "listId": 123,
  "name": "<string>",
  "dynamic": true,
  "listType": "STATIC",
  "portalId": 123,
  "createdAt": 123,
  "updatedAt": 123,
  "internalListId": 123,
  "deleteable": true,
  "metaData": {
    "processing": "<string>",
    "size": 123,
    "error": "<string>",
    "lastProcessingStateChangeAt": 123,
    "lastSizeChangeAt": 123
  },
  "filters": [
    [
      {}
    ]
  ]
}

Body

application/json
​
name
string
required

You need to include a unique name for the list you're creating.

​
dynamic
boolean
default:false

Boolean value that identifies whether your list is static or dynamic. Dynamic lists change as new contacts are created or updated. Static lists don't change.

​
filters
object[][]

A list of filters that you will use to define what contacts are included in your list. Defaults to an empty list, meaning no filters/criteria for the list.

Response

201 - application/json

Successfully created contact list

​
listId
integer
​
name
string
​
dynamic
boolean
​
listType
enum<string>
Available options:
STATIC,
DYNAMIC
​
portalId
integer
​
createdAt
integer
​
updatedAt
integer
​
internalListId
integer
​
deleteable
boolean
​
metaData
object
​
filters
object[][]