Enterprise Account Required for API Access to Custom Tags.
List Custom Tags
Request URL
Query parameters
None
Sample Response
{
"message": "OK",
"tags":[
{"id":1234, "name":"tag1", "description":"descr1"},
{"id":1235, "name":"tag2", "description":null}
]
}
Find Custom Tag by Name
Request URL
Query parameters
name - String
Example Request
Sample response
[{
"message":"OK",
"tags":[{"id":14111, "name":"Hardware", "description":"API update"}]
}]
Find Custom Tag by ID
Request URL
Query parameters
None
Example Request
Sample response
{
"message":"OK",
"tag":{"id":14111, "name":"Hardware", "description":"API update"}
}
Create Custom Tags
Request URL
Query parameters
None
JSON request data
{
"name" : String (required, length 1-100),
"description" : String (optional, length 0-200)
}
Sample request body
[{
"name" : "API Test",
"description" : "API Test",
}]
Sample response
{
"message":"OK",
"tags":[{"id":14104,"name":"API Test","description":"API Test"}]
}
Update Custom Tags
Request URL
Query parameters
None
JSON request data
[
{
"name" : String (required, length 1-100),
"description" : String (optional, length 0-200)
},
{...}
]
Sample Request
[{
"name" : "API Test New",
"description" : "API Test",
},
{
"name" : "Sales Meeting",
"description" : "Update",
}]
Sample Response
{
"message":"OK",
"updatedRows":2,
"deletedRows":0
}
Delete Custom Tag by ID
Request URL
Query parameters
None
Sample request
Sample Response
{
"message":"OK",
}
Delete All Custom Tags
Delete All Custom Tags
Request URL
Query parameters
None
Sample Response
{
"message":"OK",
"deletedRows":2,
}