Create tag
curl --request POST \
--url https://api.hubapi.com/crm/object-tags/2026-09-beta/{objectTypeId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"color": "<string>",
"displayOrder": 123,
"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>"
}
]
},
"filterPipelineIds": [
"<string>"
],
"name": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.hubapi.com/crm/object-tags/2026-09-beta/{objectTypeId}"
payload = {
"color": "<string>",
"displayOrder": 123,
"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>"
}
]
},
"filterPipelineIds": ["<string>"],
"name": "<string>",
"description": "<string>"
}
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({
color: '<string>',
displayOrder: 123,
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>'
}
]
},
filterPipelineIds: ['<string>'],
name: '<string>',
description: '<string>'
})
};
fetch('https://api.hubapi.com/crm/object-tags/2026-09-beta/{objectTypeId}', 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/object-tags/2026-09-beta/{objectTypeId}",
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([
'color' => '<string>',
'displayOrder' => 123,
'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>'
]
]
],
'filterPipelineIds' => [
'<string>'
],
'name' => '<string>',
'description' => '<string>'
]),
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/object-tags/2026-09-beta/{objectTypeId}"
payload := strings.NewReader("{\n \"color\": \"<string>\",\n \"displayOrder\": 123,\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 \"filterPipelineIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\"\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/object-tags/2026-09-beta/{objectTypeId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"color\": \"<string>\",\n \"displayOrder\": 123,\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 \"filterPipelineIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/crm/object-tags/2026-09-beta/{objectTypeId}")
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 \"color\": \"<string>\",\n \"displayOrder\": 123,\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 \"filterPipelineIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"color": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"displayOrder": 123,
"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>"
}
]
},
"filterPipelineIds": [
"<string>"
],
"id": "<string>",
"name": "<string>",
"objectTypeId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": 123,
"description": "<string>",
"lastModifiedBy": 123
}{
"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"
}
}Object Tags
Create tag
Create a new CRM object tag for a specified object type in your HubSpot account. This endpoint allows you to define properties such as name, color, and filter criteria for the tag. It is useful for categorizing and organizing CRM objects based on custom criteria.
POST
/
crm
/
object-tags
/
2026-09-beta
/
{objectTypeId}
Create tag
curl --request POST \
--url https://api.hubapi.com/crm/object-tags/2026-09-beta/{objectTypeId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"color": "<string>",
"displayOrder": 123,
"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>"
}
]
},
"filterPipelineIds": [
"<string>"
],
"name": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.hubapi.com/crm/object-tags/2026-09-beta/{objectTypeId}"
payload = {
"color": "<string>",
"displayOrder": 123,
"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>"
}
]
},
"filterPipelineIds": ["<string>"],
"name": "<string>",
"description": "<string>"
}
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({
color: '<string>',
displayOrder: 123,
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>'
}
]
},
filterPipelineIds: ['<string>'],
name: '<string>',
description: '<string>'
})
};
fetch('https://api.hubapi.com/crm/object-tags/2026-09-beta/{objectTypeId}', 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/object-tags/2026-09-beta/{objectTypeId}",
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([
'color' => '<string>',
'displayOrder' => 123,
'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>'
]
]
],
'filterPipelineIds' => [
'<string>'
],
'name' => '<string>',
'description' => '<string>'
]),
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/object-tags/2026-09-beta/{objectTypeId}"
payload := strings.NewReader("{\n \"color\": \"<string>\",\n \"displayOrder\": 123,\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 \"filterPipelineIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\"\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/object-tags/2026-09-beta/{objectTypeId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"color\": \"<string>\",\n \"displayOrder\": 123,\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 \"filterPipelineIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/crm/object-tags/2026-09-beta/{objectTypeId}")
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 \"color\": \"<string>\",\n \"displayOrder\": 123,\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 \"filterPipelineIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"color": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"displayOrder": 123,
"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>"
}
]
},
"filterPipelineIds": [
"<string>"
],
"id": "<string>",
"name": "<string>",
"objectTypeId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": 123,
"description": "<string>",
"lastModifiedBy": 123
}{
"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
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the object type for which the tag is being created.
Body
application/json
The color associated with the CRM object tag. It is a string value.
An integer indicating the order in which the tag should be displayed.
Defines the filter criteria for the CRM object tag. It can be one of several filter branch types.
- OR
- AND
- NOT_ALL
- NOT_ANY
- RESTRICTED
- UNIFIED_EVENTS
- ASSOCIATION
Show child attributes
Show child attributes
An array of strings representing the IDs of the pipelines to which the tag applies.
The name of the CRM object tag. It is a string value.
A string providing additional information about the CRM object tag.
Response
successful operation
The color associated with the CRM object tag, represented as a string.
The date and time when the tag was created, in ISO 8601 format.
An integer indicating the display order of the tag.
A complex object defining the filter branch associated with the tag, which can include various filter types and branches.
- OR
- AND
- NOT_ALL
- NOT_ANY
- RESTRICTED
- UNIFIED_EVENTS
- ASSOCIATION
Show child attributes
Show child attributes
An array of strings representing the pipeline IDs that this tag is associated with.
The unique identifier for the CRM object tag, represented as a string.
The name of the CRM object tag, represented as a string.
The identifier for the type of object this tag is associated with, represented as a string.
The date and time when the tag was last updated, in ISO 8601 format.
An integer representing the ID of the user who created the tag.
A string providing a description of the CRM object tag.
An integer representing the ID of the user who last modified the tag.
Last modified on August 3, 2026
Was this page helpful?
⌘I