Notas de Implementação:
Método para salvar o contato.
Informações de Envio:
Cabeçalhos de Envio:
| Parâmetro | Valor | Descrição | Tipo de parâmetro | Tipo de dados |
|---|---|---|---|---|
| Authorization | Bearer | Hash gerado no login | Header | String |
Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar
Itens de Menu:
CG00750,CG00783,CG00791,CG02075,CG02103
Modelo:
Dados do contato que deseja salvar em formato ContatoDTO.
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| Sequencia |
Sequencia do contato. O valor deve ser único para a empresa em que será vinculado o contato. |
integer |
Obrigatório Somente enviar se for alteração, não enviar se for inclusão |
| CodigoEmpresa |
Código de empresa em que será vinculado o contato. |
string |
Obrigatório |
| CodigoPessoa |
Código de pessoa física para o contato. |
string |
Opcional |
| Nome |
Nome do contato. |
string |
Opcional |
| Telefone |
Telefone do contato. |
string |
Opcional |
|
E-mail do contato. Esta informação será utilizada apenas se o parâmetro CadParemetros for diferente de true e se a configuração 2447 não estiver como restrita. |
string |
Opcional |
|
| Tratamento |
Tratamento para o contato. Esta informação só será utilizada se o parâmetro CadParemetros for diferente de true. |
string |
Opcional Tamanho Máximo: 6 |
| Cargo |
Cargo do contato. Esta informação será utilizada apenas se o parâmetro CadParemetros for diferente de true e se a configuração 2447 não estiver como restrita. |
string |
Opcional |
| Fone |
Fone do contato. Esta informação será utilizada apenas se o parâmetro CadParemetros for diferente de true e se a configuração 2447 não estiver como restrita. |
string |
Opcional |
| Celular |
Celular do contato. Esta informação será utilizada apenas se o parâmetro CadParemetros for diferente de true e se a configuração 2447 não estiver como restrita. |
string |
Opcional |
| DataModificacao |
Data de modificação. |
date |
Opcional |
| HoraModificacao |
Hora de modificação. |
string |
Opcional Formato: HH:MM:SS |
| CadParametros |
Cadastro de parâmetros. |
boolean |
Opcional |
| Foto |
Diretório contendo a foto do contato. |
string |
Opcional |
| Contato |
Nome do contato. Está informação só será utilizada se o parâmetro CadParemetros for diferente de true. |
string |
Opcional |
| OpcoesAuxiliares |
Define as propriedades auxiliares do contato. As opções são respectivamente RecebeNfe, TransportadoraProjNfe, Ativo, RecebeOrcamento, RecebePedido e BloqueiaTeleMarketing. |
string |
Opcional Tamanho Máximo: 6 Opções: "SSSSSS" = Todas opções marcadas, "NNNNNN" = Nenhuma opção marcada |
| RecebeNfe |
Define se o contato recebe e-mail de NFe. |
boolean |
Opcional |
| TransportadoraProjNfe |
Define se o contato utiliza Transportadora (Projeto NFe). |
string |
Opcional Tamanho Único: 1 Faixa: "S" = Sim, "N" = Não |
| Ativo |
Define se o contato está ativo. |
boolean |
Opcional |
| RecebeOrcamento |
Define se o contato recebe e-mail de orçamento em PDF. |
boolean |
Opcional |
| RecebePedido |
Define se o contato recebe e-mail de orçamento em PDF. |
boolean |
Opcional |
| BloqueiaTeleMarketing |
Define se o contato utiliza bloqueio de telemarketing. |
boolean |
Opcional |
| RecebeCartaCobranca |
Define se o contato recebe e-mail de carta cobrança. |
boolean |
Opcional |
| NotificacaoBloquetoEmail |
Define se o contato possui respectivamente as opções RecebeBoletoCobrancaBanco e RecebeBoleto marcadas. |
string |
Opcional Tamanho Máximo: 2 Opções: "SS" = As duas opçções marcadas, "NN" = Nenhuma opção marcada |
| RecebeBoletoCobrancaBanco |
Define se o contato recebe do banco e-mail com boleto de cobrança. |
boolean |
Opcional |
| RecebeBoleto |
Define se o contato recebe boleto por e-mail. |
string |
Opcional Tamanho Único: 1 "S" = Sim, "N" = Não |
Formato de Envio:
application/json, text/json
{
"Sequencia": 1,
"CodigoEmpresa": "string 1",
"CodigoPessoa": "string 2",
"Nome": "string 3",
"Telefone": "string 4",
"Email": "string 5",
"Tratamento": "string 6",
"Cargo": "string 7",
"Fone": "string 8",
"Celular": "string 9",
"DataModificacao": "2026-01-13",
"HoraModificacao": "string 10",
"CadParametros": true,
"Foto": "string 12",
"Contato": "string 13",
"OpcoesAuxiliares": "SsSSSSg 16SNNN",
"RecebeNfe": true,
"TransportadoraProjNfe": "s",
"Ativo": true,
"RecebeOrcamento": true,
"RecebePedido": true,
"BloqueiaTeleMarketing": true,
"RecebeCartaCobranca": true,
"NotificacaoBloquetoEmail": "Sstring 24",
"RecebeBoletoCobrancaBanco": true,
"RecebeBoleto": "s"
}
Informações de Retorno:
Cabeçalhos Adicionais:
| Nome | Descrição | Valor |
|---|---|---|
| cigam-api-version | Versão do build/compilação dessa versão da API | 2.1.8565.21067 |
Modelo:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| success | boolean |
Opcional |
|
| hash | string |
Opcional |
|
| messages | string |
Opcional |
|
| data | Object |
Opcional |
|
| tipoLogin | string |
Opcional |
Formato de Resposta:
Retorna os dados do contato salvo
| Código de status HTTP | Descrição | Modelo de resposta |
|---|---|---|
| 200 | OK |
application/json, text/json
Exemplo:
{
"success": true,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 400 | Requisição inválida |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 401 | Não autorizado |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 500 | Requisição falhou |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 502 | Falha de comunicação |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|