Ir para conteúdo principal

API Web - Etiquetas Personalizadas

Documentação da API Web para Gestão de Etiquetas Personalizadas

É necessária uma Conta Enterprise para acesso à API para Etiquetas Personalizadas.

Listar Etiquetas Personalizadas

URL do Pedido

Parâmetros de consulta

Nenhum

Exemplo de Resposta

{
"message": "OK",
"tags":[
{"id":1234, "name":"tag1", "description":"descr1"},
{"id":1235, "name":"tag2", "description":null}
]
}

Encontrar Etiqueta Personalizada por Nome

URL do Pedido

Parâmetros de consulta

name - String

Exemplo de Pedido

Exemplo de resposta

[{
"message":"OK",
"tags":[{"id":14111, "name":"Hardware", "description":"API update"}]
}]

Encontrar Etiqueta Personalizada por ID

URL do Pedido

Parâmetros de consulta

Nenhum

Exemplo de Pedido

Exemplo de resposta

{
"message":"OK",
"tag":{"id":14111, "name":"Hardware", "description":"API update"}
}

Criar Etiquetas Personalizadas

URL do Pedido

Parâmetros de consulta

Nenhum

Dados JSON do pedido

{
"name" : String (required, length 1-100),
"description" : String (optional, length 0-200)
}

Exemplo de corpo do pedido

[{
"name" : "API Test",
"description" : "API Test",
}]

Exemplo de resposta

{
"message":"OK",
"tags":[{"id":14104,"name":"API Test","description":"API Test"}]
}

Atualizar Etiquetas Personalizadas

URL do Pedido

Parâmetros de consulta

Nenhum

Dados JSON do pedido

[
{
"name" : String (required, length 1-100),
"description" : String (optional, length 0-200)
},
{...}
]

Exemplo de Pedido

[{
"name" : "API Test New",
"description" : "API Test",
},
{
"name" : "Sales Meeting",
"description" : "Update",
}]

Exemplo de Resposta

{
"message":"OK",
"updatedRows":2,
"deletedRows":0
}

Eliminar Etiqueta Personalizada por ID

URL do Pedido

Parâmetros de consulta

Nenhum

Exemplo de pedido

Exemplo de Resposta

{
"message":"OK",
}

Eliminar Todas as Etiquetas Personalizadas

Eliminar Todas as Etiquetas Personalizadas

URL do Pedido

Parâmetros de consulta

Nenhum

Exemplo de Resposta

{
"message":"OK",
"deletedRows":2,
}
Isto respondeu à sua pergunta?