Create List
curl --request POST \
--url https://api.hubapi.com/crm/lists/2026-09-beta \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"objectTypeId": "<string>",
"processingType": "<string>",
"customProperties": {},
"filterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "NOT_ALL",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "NOT_ANY",
"filterBranches": [
"<unknown>"
],
"filters": [
"<unknown>"
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "BOOL",
"operator": "<string>",
"value": true
},
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "BOOL",
"operator": "<string>",
"value": true
},
"property": "<string>"
}
]
},
"listFolderId": 123,
"membershipSettings": {
"includeUnassigned": true,
"membershipTeamId": 123
}
}
'import requests
url = "https://api.hubapi.com/crm/lists/2026-09-beta"
payload = {
"name": "<string>",
"objectTypeId": "<string>",
"processingType": "<string>",
"customProperties": {},
"filterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "NOT_ALL",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "NOT_ANY",
"filterBranches": ["<unknown>"],
"filters": ["<unknown>"]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": True,
"operationType": "BOOL",
"operator": "<string>",
"value": True
},
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": True,
"operationType": "BOOL",
"operator": "<string>",
"value": True
},
"property": "<string>"
}
]
},
"listFolderId": 123,
"membershipSettings": {
"includeUnassigned": True,
"membershipTeamId": 123
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
objectTypeId: '<string>',
processingType: '<string>',
customProperties: {},
filterBranch: {
filterBranchOperator: '<string>',
filterBranchType: 'OR',
filterBranches: [
{
filterBranchOperator: '<string>',
filterBranchType: 'AND',
filterBranches: [
{
filterBranchOperator: '<string>',
filterBranchType: 'NOT_ALL',
filterBranches: [
{
filterBranchOperator: '<string>',
filterBranchType: 'NOT_ANY',
filterBranches: ['<unknown>'],
filters: ['<unknown>']
}
],
filters: [{filterType: 'PROPERTY', operation: '<unknown>', property: '<string>'}]
}
],
filters: [
{
filterType: 'PROPERTY',
operation: {
includeObjectsWithNoValueSet: true,
operationType: 'BOOL',
operator: '<string>',
value: true
},
property: '<string>'
}
]
}
],
filters: [
{
filterType: 'PROPERTY',
operation: {
includeObjectsWithNoValueSet: true,
operationType: 'BOOL',
operator: '<string>',
value: true
},
property: '<string>'
}
]
},
listFolderId: 123,
membershipSettings: {includeUnassigned: true, membershipTeamId: 123}
})
};
fetch('https://api.hubapi.com/crm/lists/2026-09-beta', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/crm/lists/2026-09-beta",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'objectTypeId' => '<string>',
'processingType' => '<string>',
'customProperties' => [
],
'filterBranch' => [
'filterBranchOperator' => '<string>',
'filterBranchType' => 'OR',
'filterBranches' => [
[
'filterBranchOperator' => '<string>',
'filterBranchType' => 'AND',
'filterBranches' => [
[
'filterBranchOperator' => '<string>',
'filterBranchType' => 'NOT_ALL',
'filterBranches' => [
[
'filterBranchOperator' => '<string>',
'filterBranchType' => 'NOT_ANY',
'filterBranches' => [
'<unknown>'
],
'filters' => [
'<unknown>'
]
]
],
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => '<unknown>',
'property' => '<string>'
]
]
]
],
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => [
'includeObjectsWithNoValueSet' => true,
'operationType' => 'BOOL',
'operator' => '<string>',
'value' => true
],
'property' => '<string>'
]
]
]
],
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => [
'includeObjectsWithNoValueSet' => true,
'operationType' => 'BOOL',
'operator' => '<string>',
'value' => true
],
'property' => '<string>'
]
]
],
'listFolderId' => 123,
'membershipSettings' => [
'includeUnassigned' => true,
'membershipTeamId' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/crm/lists/2026-09-beta"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"objectTypeId\": \"<string>\",\n \"processingType\": \"<string>\",\n \"customProperties\": {},\n \"filterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"NOT_ALL\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"NOT_ANY\",\n \"filterBranches\": [\n \"<unknown>\"\n ],\n \"filters\": [\n \"<unknown>\"\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n },\n \"listFolderId\": 123,\n \"membershipSettings\": {\n \"includeUnassigned\": true,\n \"membershipTeamId\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/crm/lists/2026-09-beta")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"objectTypeId\": \"<string>\",\n \"processingType\": \"<string>\",\n \"customProperties\": {},\n \"filterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"NOT_ALL\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"NOT_ANY\",\n \"filterBranches\": [\n \"<unknown>\"\n ],\n \"filters\": [\n \"<unknown>\"\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n },\n \"listFolderId\": 123,\n \"membershipSettings\": {\n \"includeUnassigned\": true,\n \"membershipTeamId\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/crm/lists/2026-09-beta")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"objectTypeId\": \"<string>\",\n \"processingType\": \"<string>\",\n \"customProperties\": {},\n \"filterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"NOT_ALL\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"NOT_ANY\",\n \"filterBranches\": [\n \"<unknown>\"\n ],\n \"filters\": [\n \"<unknown>\"\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n },\n \"listFolderId\": 123,\n \"membershipSettings\": {\n \"includeUnassigned\": true,\n \"membershipTeamId\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"list": {
"listId": "<string>",
"listVersion": 123,
"name": "<string>",
"objectTypeId": "<string>",
"processingStatus": "<string>",
"processingType": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdById": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"filterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "NOT_ALL",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "NOT_ANY",
"filterBranches": [
"<unknown>"
],
"filters": [
"<unknown>"
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "BOOL",
"operator": "<string>",
"value": true
},
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "BOOL",
"operator": "<string>",
"value": true
},
"property": "<string>"
}
]
},
"filtersUpdatedAt": "2023-11-07T05:31:56Z",
"listPermissions": {
"teamsWithEditAccess": [
123
],
"usersWithEditAccess": [
123
]
},
"membershipSettings": {
"includeUnassigned": true,
"membershipTeamId": 123
},
"size": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedById": "<string>"
}
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Segments (Lists)
Create List
Create a new list in your HubSpot account using the specified parameters. This endpoint allows you to define the properties and criteria for the list, which can be used for organizing and managing contacts or other CRM objects.
POST
/
crm
/
lists
/
2026-09-beta
Create List
curl --request POST \
--url https://api.hubapi.com/crm/lists/2026-09-beta \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"objectTypeId": "<string>",
"processingType": "<string>",
"customProperties": {},
"filterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "NOT_ALL",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "NOT_ANY",
"filterBranches": [
"<unknown>"
],
"filters": [
"<unknown>"
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "BOOL",
"operator": "<string>",
"value": true
},
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "BOOL",
"operator": "<string>",
"value": true
},
"property": "<string>"
}
]
},
"listFolderId": 123,
"membershipSettings": {
"includeUnassigned": true,
"membershipTeamId": 123
}
}
'import requests
url = "https://api.hubapi.com/crm/lists/2026-09-beta"
payload = {
"name": "<string>",
"objectTypeId": "<string>",
"processingType": "<string>",
"customProperties": {},
"filterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "NOT_ALL",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "NOT_ANY",
"filterBranches": ["<unknown>"],
"filters": ["<unknown>"]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": True,
"operationType": "BOOL",
"operator": "<string>",
"value": True
},
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": True,
"operationType": "BOOL",
"operator": "<string>",
"value": True
},
"property": "<string>"
}
]
},
"listFolderId": 123,
"membershipSettings": {
"includeUnassigned": True,
"membershipTeamId": 123
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
objectTypeId: '<string>',
processingType: '<string>',
customProperties: {},
filterBranch: {
filterBranchOperator: '<string>',
filterBranchType: 'OR',
filterBranches: [
{
filterBranchOperator: '<string>',
filterBranchType: 'AND',
filterBranches: [
{
filterBranchOperator: '<string>',
filterBranchType: 'NOT_ALL',
filterBranches: [
{
filterBranchOperator: '<string>',
filterBranchType: 'NOT_ANY',
filterBranches: ['<unknown>'],
filters: ['<unknown>']
}
],
filters: [{filterType: 'PROPERTY', operation: '<unknown>', property: '<string>'}]
}
],
filters: [
{
filterType: 'PROPERTY',
operation: {
includeObjectsWithNoValueSet: true,
operationType: 'BOOL',
operator: '<string>',
value: true
},
property: '<string>'
}
]
}
],
filters: [
{
filterType: 'PROPERTY',
operation: {
includeObjectsWithNoValueSet: true,
operationType: 'BOOL',
operator: '<string>',
value: true
},
property: '<string>'
}
]
},
listFolderId: 123,
membershipSettings: {includeUnassigned: true, membershipTeamId: 123}
})
};
fetch('https://api.hubapi.com/crm/lists/2026-09-beta', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/crm/lists/2026-09-beta",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'objectTypeId' => '<string>',
'processingType' => '<string>',
'customProperties' => [
],
'filterBranch' => [
'filterBranchOperator' => '<string>',
'filterBranchType' => 'OR',
'filterBranches' => [
[
'filterBranchOperator' => '<string>',
'filterBranchType' => 'AND',
'filterBranches' => [
[
'filterBranchOperator' => '<string>',
'filterBranchType' => 'NOT_ALL',
'filterBranches' => [
[
'filterBranchOperator' => '<string>',
'filterBranchType' => 'NOT_ANY',
'filterBranches' => [
'<unknown>'
],
'filters' => [
'<unknown>'
]
]
],
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => '<unknown>',
'property' => '<string>'
]
]
]
],
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => [
'includeObjectsWithNoValueSet' => true,
'operationType' => 'BOOL',
'operator' => '<string>',
'value' => true
],
'property' => '<string>'
]
]
]
],
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => [
'includeObjectsWithNoValueSet' => true,
'operationType' => 'BOOL',
'operator' => '<string>',
'value' => true
],
'property' => '<string>'
]
]
],
'listFolderId' => 123,
'membershipSettings' => [
'includeUnassigned' => true,
'membershipTeamId' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/crm/lists/2026-09-beta"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"objectTypeId\": \"<string>\",\n \"processingType\": \"<string>\",\n \"customProperties\": {},\n \"filterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"NOT_ALL\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"NOT_ANY\",\n \"filterBranches\": [\n \"<unknown>\"\n ],\n \"filters\": [\n \"<unknown>\"\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n },\n \"listFolderId\": 123,\n \"membershipSettings\": {\n \"includeUnassigned\": true,\n \"membershipTeamId\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/crm/lists/2026-09-beta")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"objectTypeId\": \"<string>\",\n \"processingType\": \"<string>\",\n \"customProperties\": {},\n \"filterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"NOT_ALL\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"NOT_ANY\",\n \"filterBranches\": [\n \"<unknown>\"\n ],\n \"filters\": [\n \"<unknown>\"\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n },\n \"listFolderId\": 123,\n \"membershipSettings\": {\n \"includeUnassigned\": true,\n \"membershipTeamId\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/crm/lists/2026-09-beta")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"objectTypeId\": \"<string>\",\n \"processingType\": \"<string>\",\n \"customProperties\": {},\n \"filterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"NOT_ALL\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"NOT_ANY\",\n \"filterBranches\": [\n \"<unknown>\"\n ],\n \"filters\": [\n \"<unknown>\"\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n },\n \"listFolderId\": 123,\n \"membershipSettings\": {\n \"includeUnassigned\": true,\n \"membershipTeamId\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"list": {
"listId": "<string>",
"listVersion": 123,
"name": "<string>",
"objectTypeId": "<string>",
"processingStatus": "<string>",
"processingType": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdById": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"filterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "NOT_ALL",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "NOT_ANY",
"filterBranches": [
"<unknown>"
],
"filters": [
"<unknown>"
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "BOOL",
"operator": "<string>",
"value": true
},
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "BOOL",
"operator": "<string>",
"value": true
},
"property": "<string>"
}
]
},
"filtersUpdatedAt": "2023-11-07T05:31:56Z",
"listPermissions": {
"teamsWithEditAccess": [
123
],
"usersWithEditAccess": [
123
]
},
"membershipSettings": {
"includeUnassigned": true,
"membershipTeamId": 123
},
"size": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedById": "<string>"
}
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
oauth2oauth2
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
A string representing the name of the list. This is used to identify the list within the system.
A string indicating the type of objects that the list will contain. This helps in categorizing the list based on the object type.
A string that specifies the processing type of the list. It defines how the list is processed within the system.
An object containing custom properties for the list. These properties allow for additional customization of the list.
Show child attributes
Show child attributes
An object that defines the filter criteria for the list. It determines which records are included in the list based on specified conditions.
- OR
- AND
- NOT_ALL
- NOT_ANY
- RESTRICTED
- UNIFIED_EVENTS
- ASSOCIATION
Show child attributes
Show child attributes
A string representing the ID of the folder where the list will be stored. This helps in organizing lists into folders.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
successful operation
Show child attributes
Show child attributes
Last modified on August 6, 2026
Was this page helpful?
⌘I