É necessária uma conta Enterprise para acessar as Tags Personalizadas pela API.
Listar Tags Personalizadas
URL da requisição
Parâmetros de consulta
Nenhum
Exemplo de resposta
{
"message": "OK",
"tags":[
{"id":1234, "name":"tag1", "description":"descr1"},
{"id":1235, "name":"tag2", "description":null}
]
}Buscar Tag Personalizada por Nome
URL da requisição
Parâmetros de consulta
name - String
Exemplo de requisição
Exemplo de resposta
[{
"message":"OK",
"tags":[{"id":14111, "name":"Hardware", "description":"API update"}]
}]Buscar Tag Personalizada por ID
URL da requisição
Parâmetros de consulta
Nenhum
Exemplo de requisição
Exemplo de resposta
{
"message":"OK",
"tag":{"id":14111, "name":"Hardware", "description":"API update"}
}Criar Tags Personalizadas
URL da requisição
Parâmetros de consulta
Nenhum
Dados da requisição JSON
{
"name" : String (required, length 1-100),
"description" : String (optional, length 0-200)
}Exemplo de corpo da requisição
[{
"name" : "API Test",
"description" : "API Test",
}]Exemplo de resposta
{
"message":"OK",
"tags":[{"id":14104,"name":"API Test","description":"API Test"}]
}Atualizar Tags Personalizadas
URL da requisição
Parâmetros de consulta
Nenhum
Dados da requisição JSON
[
{
"name" : String (required, length 1-100),
"description" : String (optional, length 0-200)
},
{...}
]
Exemplo de requisição
[{
"name" : "API Test New",
"description" : "API Test",
},
{
"name" : "Sales Meeting",
"description" : "Update",
}]Exemplo de resposta
{
"message":"OK",
"updatedRows":2,
"deletedRows":0
}Excluir Tag Personalizada por ID
URL da requisição
Parâmetros de consulta
Nenhum
Exemplo de requisição
Exemplo de resposta
{
"message":"OK",
}Excluir Todas as Tags Personalizadas
Excluir Todas as Tags Personalizadas
URL da requisição
Parâmetros de consulta
Nenhum
Exemplo de resposta
{
"message":"OK",
"deletedRows":2,
}