Etiquetas de Oportunidade

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.


Estrutura da Resposta (GET)

CampoTipoDescrição
idIntegerIdentificador único
nomeString: 50Nome da etiqueta
corIntegerCor da etiqueta (ver tabela de cores abaixo)
codigo_etiqueta_integracaoString: 60Código da etiqueta no sistema integrado. Pode ser nulo
ultima_alteracaoDateTimeData e hora da última modificação desta etiqueta no Mercos
excluidoBooleanIndica se a etiqueta está excluída

Parâmetros de Envio (POST)

CampoTipoDescrição
nome (obrigatório)String: 50Nome da etiqueta, com no mínimo 1 caractere. Espaços no início e no fim são removidos
corIntegerCor da etiqueta. Quando não informada, a etiqueta é criada com a cor 5 (Cinza)
codigo_etiqueta_integracaoString: 60Código da etiqueta no sistema integrado

Parâmetros de Envio (PUT)

Todos os campos são opcionais. Somente os campos enviados são alterados.

CampoTipoDescrição
nomeString: 50Nome da etiqueta, com no mínimo 1 caractere. Espaços no início e no fim são removidos
corIntegerCor da etiqueta
codigo_etiqueta_integracaoString: 60Código da etiqueta no sistema integrado. Envie null para limpar o código
excluidoBooleanEnvie true para excluir a etiqueta

Cores

ValorCor
0Vermelho
1Amarelo
2Verde
3Azul
4Roxo
5Cinza

Regras

  • 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.