A entidade Etiquetas de Oportunidade permite consultar, incluir, alterar e excluir as etiquetas usadas para classificar as oportunidades do funil de vendas no Mercos.
O campo codigo_etiqueta_integracao guarda o código da etiqueta no sistema integrado. Esse código não é único: mais de uma etiqueta pode ter o mesmo código.
| Campo | Tipo | Descrição |
|---|
| id | Integer | Identificador único |
| nome | String: 50 | Nome da etiqueta |
| cor | Integer | Cor da etiqueta (ver tabela de cores abaixo) |
| codigo_etiqueta_integracao | String: 60 | Código da etiqueta no sistema integrado. Pode ser nulo |
| ultima_alteracao | DateTime | Data e hora da última modificação desta etiqueta no Mercos |
| excluido | Boolean | Indica se a etiqueta está excluída |
| Campo | Tipo | Descrição |
|---|
| nome (obrigatório) | String: 50 | Nome da etiqueta, com no mínimo 1 caractere. Espaços no início e no fim são removidos |
| cor | Integer | Cor da etiqueta. Quando não informada, a etiqueta é criada com a cor 5 (Cinza) |
| codigo_etiqueta_integracao | String: 60 | Código da etiqueta no sistema integrado |
Todos os campos são opcionais. Somente os campos enviados são alterados.
| Campo | Tipo | Descrição |
|---|
| nome | String: 50 | Nome da etiqueta, com no mínimo 1 caractere. Espaços no início e no fim são removidos |
| cor | Integer | Cor da etiqueta |
| codigo_etiqueta_integracao | String: 60 | Código da etiqueta no sistema integrado. Envie null para limpar o código |
| excluido | Boolean | Envie true para excluir a etiqueta |
| Valor | Cor |
|---|
| 0 | Vermelho |
| 1 | Amarelo |
| 2 | Verde |
| 3 | Azul |
| 4 | Roxo |
| 5 | Cinza |
- Em
nome, espaços no início e no fim são removidos. Um nome vazio ou só com espaços responde 422.
- No
codigo_etiqueta_integracao, espaços no início e no fim são removidos. Um texto vazio ou só com espaços é gravado como nulo.
- Ao excluir uma etiqueta, ela também é removida das oportunidades em que estava aplicada.
- Uma etiqueta excluída não pode ser reativada nem alterada: o PUT responde 422.
- O POST com
excluido responde 422.
- No GET por id e no PUT, um ID inexistente ou de outra conta responde 422 (não 404).
- Se o plano da sua conta não inclui etiquetas de oportunidade, todos os métodos respondem 412.