Televendas Contato

contato

Obter Listagem de Contatos

get

/contato

Autorizações

AuthorizationstringObrigatório

Parâmetros de consulta

continuationTokenstringOpcional

Identificador da Paginação da Consulta

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

continuationTokenstringOpcional

Identificador da Paginação da Consulta

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/contato

GET /crm/v10/contato HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "continuationToken": "text",
  "data": [
    {
      "empresa": 1,
      "codContato": 1,
      "atendente": 1,
      "cnpj": "text",
      "cidade": "text",
      "cliente": 1,
      "consignatario": 1,
      "transportadora": 1,
      "formaContato": 1,
      "ocupacaoPesFisica": 1,
      "ramoAtividade": 1,
      "subRamoAtividade": "text",
      "representante": 1,
      "setorVenda": "text",
      "nivelServico": "text",
      "orcamentoContato": "text",
      "codLead": 1,
      "bairro": "text",
      "cepCompleto": "text",
      "codEstruturaComl": "text",
      "consumidorFinal": 0,
      "contatoPadrao": "text",
      "cxPostal": "text",
      "dataCadastro": "2026-02-28",
      "email": "text",
      "emailNfe": "text",
      "emailSecundarioNfe": "text",
      "endComplementar": "text",
      "endereco": "text",
      "enderecoNumero": "text",
      "fantasia": "text",
      "fax": "text",
      "frequenciaContato": 1,
      "frequenciaNF": 1,
      "homepage": "text",
      "inscricaoEstadual": "text",
      "uf": "text",
      "observacao": "text",
      "pais": "text",
      "proximidade": "text",
      "razaoSocial": "text",
      "rzSocCobEscritural": "text",
      "situacao": 0,
      "telefone": "text",
      "tipo": 1,
      "recMalaDireta": 0,
      "simplesNacional": 0,
      "irpjLucroPresumido": 0,
      "dataAssociacao": "2026-02-28",
      "tipoReferencia": 1,
      "enderecoEntrega": [
        {
          "sequencia": 1,
          "localEntrega": "text",
          "endereco": "text",
          "numero": "text",
          "complemento": "text",
          "bairro": "text",
          "cep": "text",
          "cpfCnpj": "text",
          "inscEstadual": "text",
          "telefone": "text",
          "horario": "text",
          "cidade": "text",
          "estado": "text"
        }
      ],
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Cadastrar um Contato

put

/contato

Autorizações

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

atendenteinteger · mín: 1 · máx: 9999Obrigatório

Código do Atendente

cnpjstring · máx: 14Opcional

Código do CNPJ

cidadestring · máx: 60Opcional

Código da Cidade

clienteinteger · máx: 9999999Opcional

Código do Cliente

consignatariointeger · máx: 9999Opcional

Código do Consignatário

transportadorainteger · máx: 9999Opcional

Código da Transportadora

formaContatointeger · máx: 999Opcional

Código da Forma de Contato

ocupacaoPesFisicainteger · máx: 999Opcional

Código da Ocupação para Pessoa Física

ramoAtividadeinteger · máx: 99Opcional

Código do Ramo de Atividade

subRamoAtividadestring · máx: 3Opcional

Código do Sub-Ramo de Atividade

representanteinteger · mín: 1 · máx: 9999Obrigatório

Código do Representante

setorVendastring · máx: 3Opcional

Código do Setor de Venda

nivelServicostring · máx: 4Opcional

Nível de Serviço

codLeadinteger · máx: 9999Opcional

Código do Lead

bairrostring · mín: 1 · máx: 30Obrigatório

Bairro

cepCompletostring · mín: 1 · máx: 8Obrigatório

Código do CEP Completo

codEstruturaComlstring · máx: 50Opcional

Código da Estrutura Comercial

consumidorFinalinteger · enumObrigatório

É Consumidor Final? (0-Sim, 1-Não)

Valores possíveis:

contatoPadraostring · máx: 50Opcional

Contato Padrão

cxPostalstring · máx: 10Opcional

Caixa Postal

dataCadastrostring · dateOpcional

Data do Cadastro (YYYY-MM-DD)

emailstring · máx: 50Opcional

E-mail Principal do Contato

emailNfestring · máx: 50Opcional

E-mail para NF-e

emailSecundarioNfestring · máx: 999Opcional

E-mail Secundário do Contato

endComplementarstring · máx: 30Opcional

Endereço Complementar

enderecostring · mín: 1 · máx: 60Obrigatório

Endereço Padrão

enderecoNumerostring · mín: 1 · máx: 10Obrigatório

Número do Endereço

fantasiastring · máx: 30Opcional

Nome Fantasia

faxstring · máx: 15Opcional

Número de Fax

frequenciaContatointeger · mín: 1 · máx: 999Obrigatório

Número de Dias em que Deve-se Entrar em Contato com o Cliente

frequenciaNFinteger · mín: 1 · máx: 9999Obrigatório

Frequência da Nota Fiscal

homepagestring · máx: 100Opcional

Home Page do Contato

inscricaoEstadualstring · máx: 15Opcional

Código da Inscrição Estadual

ufstring · mín: 2 · máx: 2Opcional

Código do Estado

observacaostring · máx: 50Opcional

Observação

paisstring · máx: 50Opcional

País do Contato

proximidadestring · máx: 25Opcional

Proximidade

razaoSocialstring · mín: 1 · máx: 60Obrigatório

Razão Social

rzSocCobEscrituralstring · máx: 40Opcional

Razão Social - Cobrança Escritural

situacaointeger · enumObrigatório

Situação (0-Inativo, 1-Ativo)

Valores possíveis:

telefonestring · mín: 1 · máx: 15Obrigatório

Número de Telefone

tipointeger · enumObrigatório

Tipo do Contato (1-Prospect, 2-Cliente)

Valores possíveis:

recMalaDiretainteger · enumObrigatório

Recebe Mala Direta? (0-Não, 1-Sim)

Valores possíveis:

simplesNacionalinteger · enumObrigatório

Contaot é Simples Nacional? (0-Não, 1-Sim)

Valores possíveis:

irpjLucroPresumidointeger · enumObrigatório

IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)

Valores possíveis:

dataAssociacaostring · dateOpcional

Data da Associação (YYYY-MM-DD)

tipoReferenciainteger · enumOpcional

Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)

Valores possíveis:

Respostas

200

application/json

empresaintegerOpcional

Código da Empresa

codContatointegerOpcional

Código do Contato

atendenteintegerOpcional

Código do Atendente

cnpjstringOpcional

Código do CNPJ

cidadestringOpcional

Código da Cidade

clienteintegerOpcional

Código do Cliente

consignatariointegerOpcional

Código do Consignatário

transportadoraintegerOpcional

Código da Transportadora

formaContatointegerOpcional

Código da Forma de Contato

ocupacaoPesFisicaintegerOpcional

Código da Ocupação para Pessoa Física

ramoAtividadeintegerOpcional

Código do Ramo de Atividade

subRamoAtividadestringOpcional

Código do Sub-Ramo de Atividade

representanteintegerOpcional

Código do Representante

setorVendastringOpcional

Código do Setor de Venda

nivelServicostringOpcional

Nível de Serviço

orcamentoContatostringOpcional

Contato Orçamento

codLeadintegerOpcional

Código do Lead

bairrostringOpcional

Bairro

cepCompletostringOpcional

CEP Completo

codEstruturaComlstringOpcional

Código da Estrutura Comercial

consumidorFinalinteger · enumOpcional

É Consumidor Final? (0-Sim, 1-Não)

Valores possíveis:

contatoPadraostringOpcional

Contato Padrão

cxPostalstringOpcional

Caixa Postal

dataCadastrostring · dateOpcional

Data do Cadastro (YYYY-MM-DD)

emailstringOpcional

E-mail Principal do Contato

emailNfestringOpcional

E-mail para NF-e

emailSecundarioNfestringOpcional

E-mail Secundário do Contato

endComplementarstringOpcional

Endereço Complementar

enderecostringOpcional

Endereço Padrão

enderecoNumerostringOpcional

Número do Endereço

fantasiastringOpcional

Nome Fantasia

faxstringOpcional

Número de Fax

frequenciaContatointegerOpcional

Número de Dias em que Deve-se Entrar em Contato com o Cliente

frequenciaNFintegerOpcional

Frequência da Nota Fiscal

homepagestringOpcional

Home Page do Contato

inscricaoEstadualstringOpcional

Código da Inscrição Estadual

ufstringOpcional

Código do Estado

observacaostringOpcional

Observação

paisstringOpcional

País do Contato

proximidadestringOpcional

Proximidade

razaoSocialstringOpcional

Razão Social

rzSocCobEscrituralstringOpcional

Razão Social - Cobrança Escritural

situacaointeger · enumOpcional

Situação (0-Inativo, 1-Ativo)

Valores possíveis:

telefonestringOpcional

Número de Telefone

tipointeger · enumOpcional

Tipo do Contato (1-Prospect, 2-Cliente)

Valores possíveis:

recMalaDiretainteger · enumOpcional

Recebe Mala Direta? (0-Não, 1-Sim)

Valores possíveis:

simplesNacionalinteger · enumOpcional

Contaot é Simples Nacional? (0-Não, 1-Sim)

Valores possíveis:

irpjLucroPresumidointeger · enumOpcional

IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)

Valores possíveis:

dataAssociacaostring · dateOpcional

Data da Associação (YYYY-MM-DD)

tipoReferenciainteger · enumOpcional

Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)

Valores possíveis:

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/contato

PUT /crm/v10/contato HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 1212

{
  "atendente": 1,
  "cnpj": "text",
  "cidade": "text",
  "cliente": 1,
  "consignatario": 1,
  "transportadora": 1,
  "formaContato": 1,
  "ocupacaoPesFisica": 1,
  "ramoAtividade": 1,
  "subRamoAtividade": "text",
  "representante": 1,
  "setorVenda": "text",
  "nivelServico": "text",
  "codLead": 1,
  "bairro": "text",
  "cepCompleto": "text",
  "codEstruturaComl": "text",
  "consumidorFinal": 0,
  "contatoPadrao": "text",
  "cxPostal": "text",
  "dataCadastro": "2026-02-28",
  "email": "text",
  "emailNfe": "text",
  "emailSecundarioNfe": "text",
  "endComplementar": "text",
  "endereco": "text",
  "enderecoNumero": "text",
  "fantasia": "text",
  "fax": "text",
  "frequenciaContato": 1,
  "frequenciaNF": 1,
  "homepage": "text",
  "inscricaoEstadual": "text",
  "uf": "text",
  "observacao": "text",
  "pais": "text",
  "proximidade": "text",
  "razaoSocial": "text",
  "rzSocCobEscritural": "text",
  "situacao": 0,
  "telefone": "text",
  "tipo": 1,
  "recMalaDireta": 0,
  "simplesNacional": 0,
  "irpjLucroPresumido": 0,
  "dataAssociacao": "2026-02-28",
  "tipoReferencia": 1,
  "enderecoEntrega": [
    {
      "sequencia": 1,
      "localEntrega": "text",
      "endereco": "text",
      "numero": "text",
      "complemento": "text",
      "bairro": "text",
      "cep": "text",
      "cpfCnpj": "text",
      "inscEstadual": "text",
      "telefone": "text",
      "horario": "text",
      "cidade": "text",
      "estado": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "empresa": 1,
  "codContato": 1,
  "atendente": 1,
  "cnpj": "text",
  "cidade": "text",
  "cliente": 1,
  "consignatario": 1,
  "transportadora": 1,
  "formaContato": 1,
  "ocupacaoPesFisica": 1,
  "ramoAtividade": 1,
  "subRamoAtividade": "text",
  "representante": 1,
  "setorVenda": "text",
  "nivelServico": "text",
  "orcamentoContato": "text",
  "codLead": 1,
  "bairro": "text",
  "cepCompleto": "text",
  "codEstruturaComl": "text",
  "consumidorFinal": 0,
  "contatoPadrao": "text",
  "cxPostal": "text",
  "dataCadastro": "2026-02-28",
  "email": "text",
  "emailNfe": "text",
  "emailSecundarioNfe": "text",
  "endComplementar": "text",
  "endereco": "text",
  "enderecoNumero": "text",
  "fantasia": "text",
  "fax": "text",
  "frequenciaContato": 1,
  "frequenciaNF": 1,
  "homepage": "text",
  "inscricaoEstadual": "text",
  "uf": "text",
  "observacao": "text",
  "pais": "text",
  "proximidade": "text",
  "razaoSocial": "text",
  "rzSocCobEscritural": "text",
  "situacao": 0,
  "telefone": "text",
  "tipo": 1,
  "recMalaDireta": 0,
  "simplesNacional": 0,
  "irpjLucroPresumido": 0,
  "dataAssociacao": "2026-02-28",
  "tipoReferencia": 1,
  "enderecoEntrega": [
    {
      "sequencia": 1,
      "localEntrega": "text",
      "endereco": "text",
      "numero": "text",
      "complemento": "text",
      "bairro": "text",
      "cep": "text",
      "cpfCnpj": "text",
      "inscEstadual": "text",
      "telefone": "text",
      "horario": "text",
      "cidade": "text",
      "estado": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Obter um Contato

get

/contato/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Contato

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

empresaintegerOpcional

Código da Empresa

codContatointegerOpcional

Código do Contato

atendenteintegerOpcional

Código do Atendente

cnpjstringOpcional

Código do CNPJ

cidadestringOpcional

Código da Cidade

clienteintegerOpcional

Código do Cliente

consignatariointegerOpcional

Código do Consignatário

transportadoraintegerOpcional

Código da Transportadora

formaContatointegerOpcional

Código da Forma de Contato

ocupacaoPesFisicaintegerOpcional

Código da Ocupação para Pessoa Física

ramoAtividadeintegerOpcional

Código do Ramo de Atividade

subRamoAtividadestringOpcional

Código do Sub-Ramo de Atividade

representanteintegerOpcional

Código do Representante

setorVendastringOpcional

Código do Setor de Venda

nivelServicostringOpcional

Nível de Serviço

orcamentoContatostringOpcional

Contato Orçamento

codLeadintegerOpcional

Código do Lead

bairrostringOpcional

Bairro

cepCompletostringOpcional

CEP Completo

codEstruturaComlstringOpcional

Código da Estrutura Comercial

consumidorFinalinteger · enumOpcional

É Consumidor Final? (0-Sim, 1-Não)

Valores possíveis:

contatoPadraostringOpcional

Contato Padrão

cxPostalstringOpcional

Caixa Postal

dataCadastrostring · dateOpcional

Data do Cadastro (YYYY-MM-DD)

emailstringOpcional

E-mail Principal do Contato

emailNfestringOpcional

E-mail para NF-e

emailSecundarioNfestringOpcional

E-mail Secundário do Contato

endComplementarstringOpcional

Endereço Complementar

enderecostringOpcional

Endereço Padrão

enderecoNumerostringOpcional

Número do Endereço

fantasiastringOpcional

Nome Fantasia

faxstringOpcional

Número de Fax

frequenciaContatointegerOpcional

Número de Dias em que Deve-se Entrar em Contato com o Cliente

frequenciaNFintegerOpcional

Frequência da Nota Fiscal

homepagestringOpcional

Home Page do Contato

inscricaoEstadualstringOpcional

Código da Inscrição Estadual

ufstringOpcional

Código do Estado

observacaostringOpcional

Observação

paisstringOpcional

País do Contato

proximidadestringOpcional

Proximidade

razaoSocialstringOpcional

Razão Social

rzSocCobEscrituralstringOpcional

Razão Social - Cobrança Escritural

situacaointeger · enumOpcional

Situação (0-Inativo, 1-Ativo)

Valores possíveis:

telefonestringOpcional

Número de Telefone

tipointeger · enumOpcional

Tipo do Contato (1-Prospect, 2-Cliente)

Valores possíveis:

recMalaDiretainteger · enumOpcional

Recebe Mala Direta? (0-Não, 1-Sim)

Valores possíveis:

simplesNacionalinteger · enumOpcional

Contaot é Simples Nacional? (0-Não, 1-Sim)

Valores possíveis:

irpjLucroPresumidointeger · enumOpcional

IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)

Valores possíveis:

dataAssociacaostring · dateOpcional

Data da Associação (YYYY-MM-DD)

tipoReferenciainteger · enumOpcional

Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)

Valores possíveis:

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/contato/{id}

GET /crm/v10/contato/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

[
  {
    "empresa": 1,
    "codContato": 1,
    "atendente": 1,
    "cnpj": "text",
    "cidade": "text",
    "cliente": 1,
    "consignatario": 1,
    "transportadora": 1,
    "formaContato": 1,
    "ocupacaoPesFisica": 1,
    "ramoAtividade": 1,
    "subRamoAtividade": "text",
    "representante": 1,
    "setorVenda": "text",
    "nivelServico": "text",
    "orcamentoContato": "text",
    "codLead": 1,
    "bairro": "text",
    "cepCompleto": "text",
    "codEstruturaComl": "text",
    "consumidorFinal": 0,
    "contatoPadrao": "text",
    "cxPostal": "text",
    "dataCadastro": "2026-02-28",
    "email": "text",
    "emailNfe": "text",
    "emailSecundarioNfe": "text",
    "endComplementar": "text",
    "endereco": "text",
    "enderecoNumero": "text",
    "fantasia": "text",
    "fax": "text",
    "frequenciaContato": 1,
    "frequenciaNF": 1,
    "homepage": "text",
    "inscricaoEstadual": "text",
    "uf": "text",
    "observacao": "text",
    "pais": "text",
    "proximidade": "text",
    "razaoSocial": "text",
    "rzSocCobEscritural": "text",
    "situacao": 0,
    "telefone": "text",
    "tipo": 1,
    "recMalaDireta": 0,
    "simplesNacional": 0,
    "irpjLucroPresumido": 0,
    "dataAssociacao": "2026-02-28",
    "tipoReferencia": 1,
    "enderecoEntrega": [
      {
        "sequencia": 1,
        "localEntrega": "text",
        "endereco": "text",
        "numero": "text",
        "complemento": "text",
        "bairro": "text",
        "cep": "text",
        "cpfCnpj": "text",
        "inscEstadual": "text",
        "telefone": "text",
        "horario": "text",
        "cidade": "text",
        "estado": "text"
      }
    ],
    "dadosCustomizados": [
      {
        "campo": "text",
        "valor": "text"
      }
    ]
  }
]

Atualizar um Contato

put

/contato/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Contato

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

atendenteinteger · mín: 1 · máx: 9999Obrigatório

Código do Atendente

cnpjstring · máx: 14Opcional

Código do CNPJ

cidadestring · máx: 60Opcional

Código da Cidade

clienteinteger · máx: 9999999Opcional

Código do Cliente

consignatariointeger · máx: 9999Opcional

Código do Consignatário

transportadorainteger · máx: 9999Opcional

Código da Transportadora

formaContatointeger · máx: 999Opcional

Código da Forma de Contato

ocupacaoPesFisicainteger · máx: 999Opcional

Código da Ocupação para Pessoa Física

ramoAtividadeinteger · máx: 99Opcional

Código do Ramo de Atividade

subRamoAtividadestring · máx: 3Opcional

Código do Sub-Ramo de Atividade

representanteinteger · mín: 1 · máx: 9999Obrigatório

Código do Representante

setorVendastring · máx: 3Opcional

Código do Setor de Venda

nivelServicostring · máx: 4Opcional

Nível de Serviço

codLeadinteger · máx: 9999Opcional

Código do Lead

bairrostring · mín: 1 · máx: 30Obrigatório

Bairro

cepCompletostring · mín: 1 · máx: 8Obrigatório

Código do CEP Completo

codEstruturaComlstring · máx: 50Opcional

Código da Estrutura Comercial

consumidorFinalinteger · enumObrigatório

É Consumidor Final? (0-Sim, 1-Não)

Valores possíveis:

contatoPadraostring · máx: 50Opcional

Contato Padrão

cxPostalstring · máx: 10Opcional

Caixa Postal

dataCadastrostring · dateOpcional

Data do Cadastro (YYYY-MM-DD)

emailstring · máx: 50Opcional

E-mail Principal do Contato

emailNfestring · máx: 50Opcional

E-mail para NF-e

emailSecundarioNfestring · máx: 999Opcional

E-mail Secundário do Contato

endComplementarstring · máx: 30Opcional

Endereço Complementar

enderecostring · mín: 1 · máx: 60Obrigatório

Endereço Padrão

enderecoNumerostring · mín: 1 · máx: 10Obrigatório

Número do Endereço

fantasiastring · máx: 30Opcional

Nome Fantasia

faxstring · máx: 15Opcional

Número de Fax

frequenciaContatointeger · mín: 1 · máx: 999Obrigatório

Número de Dias em que Deve-se Entrar em Contato com o Cliente

frequenciaNFinteger · mín: 1 · máx: 9999Obrigatório

Frequência da Nota Fiscal

homepagestring · máx: 100Opcional

Home Page do Contato

inscricaoEstadualstring · máx: 15Opcional

Código da Inscrição Estadual

ufstring · mín: 2 · máx: 2Opcional

Código do Estado

observacaostring · máx: 50Opcional

Observação

paisstring · máx: 50Opcional

País do Contato

proximidadestring · máx: 25Opcional

Proximidade

razaoSocialstring · mín: 1 · máx: 60Obrigatório

Razão Social

rzSocCobEscrituralstring · máx: 40Opcional

Razão Social - Cobrança Escritural

situacaointeger · enumObrigatório

Situação (0-Inativo, 1-Ativo)

Valores possíveis:

telefonestring · mín: 1 · máx: 15Obrigatório

Número de Telefone

tipointeger · enumObrigatório

Tipo do Contato (1-Prospect, 2-Cliente)

Valores possíveis:

recMalaDiretainteger · enumObrigatório

Recebe Mala Direta? (0-Não, 1-Sim)

Valores possíveis:

simplesNacionalinteger · enumObrigatório

Contaot é Simples Nacional? (0-Não, 1-Sim)

Valores possíveis:

irpjLucroPresumidointeger · enumObrigatório

IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)

Valores possíveis:

dataAssociacaostring · dateOpcional

Data da Associação (YYYY-MM-DD)

tipoReferenciainteger · enumOpcional

Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)

Valores possíveis:

Respostas

200

application/json

empresaintegerOpcional

Código da Empresa

codContatointegerOpcional

Código do Contato

atendenteintegerOpcional

Código do Atendente

cnpjstringOpcional

Código do CNPJ

cidadestringOpcional

Código da Cidade

clienteintegerOpcional

Código do Cliente

consignatariointegerOpcional

Código do Consignatário

transportadoraintegerOpcional

Código da Transportadora

formaContatointegerOpcional

Código da Forma de Contato

ocupacaoPesFisicaintegerOpcional

Código da Ocupação para Pessoa Física

ramoAtividadeintegerOpcional

Código do Ramo de Atividade

subRamoAtividadestringOpcional

Código do Sub-Ramo de Atividade

representanteintegerOpcional

Código do Representante

setorVendastringOpcional

Código do Setor de Venda

nivelServicostringOpcional

Nível de Serviço

orcamentoContatostringOpcional

Contato Orçamento

codLeadintegerOpcional

Código do Lead

bairrostringOpcional

Bairro

cepCompletostringOpcional

CEP Completo

codEstruturaComlstringOpcional

Código da Estrutura Comercial

consumidorFinalinteger · enumOpcional

É Consumidor Final? (0-Sim, 1-Não)

Valores possíveis:

contatoPadraostringOpcional

Contato Padrão

cxPostalstringOpcional

Caixa Postal

dataCadastrostring · dateOpcional

Data do Cadastro (YYYY-MM-DD)

emailstringOpcional

E-mail Principal do Contato

emailNfestringOpcional

E-mail para NF-e

emailSecundarioNfestringOpcional

E-mail Secundário do Contato

endComplementarstringOpcional

Endereço Complementar

enderecostringOpcional

Endereço Padrão

enderecoNumerostringOpcional

Número do Endereço

fantasiastringOpcional

Nome Fantasia

faxstringOpcional

Número de Fax

frequenciaContatointegerOpcional

Número de Dias em que Deve-se Entrar em Contato com o Cliente

frequenciaNFintegerOpcional

Frequência da Nota Fiscal

homepagestringOpcional

Home Page do Contato

inscricaoEstadualstringOpcional

Código da Inscrição Estadual

ufstringOpcional

Código do Estado

observacaostringOpcional

Observação

paisstringOpcional

País do Contato

proximidadestringOpcional

Proximidade

razaoSocialstringOpcional

Razão Social

rzSocCobEscrituralstringOpcional

Razão Social - Cobrança Escritural

situacaointeger · enumOpcional

Situação (0-Inativo, 1-Ativo)

Valores possíveis:

telefonestringOpcional

Número de Telefone

tipointeger · enumOpcional

Tipo do Contato (1-Prospect, 2-Cliente)

Valores possíveis:

recMalaDiretainteger · enumOpcional

Recebe Mala Direta? (0-Não, 1-Sim)

Valores possíveis:

simplesNacionalinteger · enumOpcional

Contaot é Simples Nacional? (0-Não, 1-Sim)

Valores possíveis:

irpjLucroPresumidointeger · enumOpcional

IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)

Valores possíveis:

dataAssociacaostring · dateOpcional

Data da Associação (YYYY-MM-DD)

tipoReferenciainteger · enumOpcional

Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)

Valores possíveis:

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/contato/{id}

PUT /crm/v10/contato/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 1212

{
  "atendente": 1,
  "cnpj": "text",
  "cidade": "text",
  "cliente": 1,
  "consignatario": 1,
  "transportadora": 1,
  "formaContato": 1,
  "ocupacaoPesFisica": 1,
  "ramoAtividade": 1,
  "subRamoAtividade": "text",
  "representante": 1,
  "setorVenda": "text",
  "nivelServico": "text",
  "codLead": 1,
  "bairro": "text",
  "cepCompleto": "text",
  "codEstruturaComl": "text",
  "consumidorFinal": 0,
  "contatoPadrao": "text",
  "cxPostal": "text",
  "dataCadastro": "2026-02-28",
  "email": "text",
  "emailNfe": "text",
  "emailSecundarioNfe": "text",
  "endComplementar": "text",
  "endereco": "text",
  "enderecoNumero": "text",
  "fantasia": "text",
  "fax": "text",
  "frequenciaContato": 1,
  "frequenciaNF": 1,
  "homepage": "text",
  "inscricaoEstadual": "text",
  "uf": "text",
  "observacao": "text",
  "pais": "text",
  "proximidade": "text",
  "razaoSocial": "text",
  "rzSocCobEscritural": "text",
  "situacao": 0,
  "telefone": "text",
  "tipo": 1,
  "recMalaDireta": 0,
  "simplesNacional": 0,
  "irpjLucroPresumido": 0,
  "dataAssociacao": "2026-02-28",
  "tipoReferencia": 1,
  "enderecoEntrega": [
    {
      "sequencia": 1,
      "localEntrega": "text",
      "endereco": "text",
      "numero": "text",
      "complemento": "text",
      "bairro": "text",
      "cep": "text",
      "cpfCnpj": "text",
      "inscEstadual": "text",
      "telefone": "text",
      "horario": "text",
      "cidade": "text",
      "estado": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "empresa": 1,
  "codContato": 1,
  "atendente": 1,
  "cnpj": "text",
  "cidade": "text",
  "cliente": 1,
  "consignatario": 1,
  "transportadora": 1,
  "formaContato": 1,
  "ocupacaoPesFisica": 1,
  "ramoAtividade": 1,
  "subRamoAtividade": "text",
  "representante": 1,
  "setorVenda": "text",
  "nivelServico": "text",
  "orcamentoContato": "text",
  "codLead": 1,
  "bairro": "text",
  "cepCompleto": "text",
  "codEstruturaComl": "text",
  "consumidorFinal": 0,
  "contatoPadrao": "text",
  "cxPostal": "text",
  "dataCadastro": "2026-02-28",
  "email": "text",
  "emailNfe": "text",
  "emailSecundarioNfe": "text",
  "endComplementar": "text",
  "endereco": "text",
  "enderecoNumero": "text",
  "fantasia": "text",
  "fax": "text",
  "frequenciaContato": 1,
  "frequenciaNF": 1,
  "homepage": "text",
  "inscricaoEstadual": "text",
  "uf": "text",
  "observacao": "text",
  "pais": "text",
  "proximidade": "text",
  "razaoSocial": "text",
  "rzSocCobEscritural": "text",
  "situacao": 0,
  "telefone": "text",
  "tipo": 1,
  "recMalaDireta": 0,
  "simplesNacional": 0,
  "irpjLucroPresumido": 0,
  "dataAssociacao": "2026-02-28",
  "tipoReferencia": 1,
  "enderecoEntrega": [
    {
      "sequencia": 1,
      "localEntrega": "text",
      "endereco": "text",
      "numero": "text",
      "complemento": "text",
      "bairro": "text",
      "cep": "text",
      "cpfCnpj": "text",
      "inscEstadual": "text",
      "telefone": "text",
      "horario": "text",
      "cidade": "text",
      "estado": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Excluir um Contato

delete

/contato/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Contato

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

delete

/contato/{id}

DELETE /crm/v10/contato/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

Sem conteúdo

AnteriorTelevendas - CRM v1.0 PróximoTelevendas Orçamento

Atualizado há 1 mês

Boa noite

hashtagObter Listagem de Contatos

hashtagCadastrar um Contato

hashtagObter um Contato

hashtagAtualizar um Contato

hashtagExcluir um Contato

Obter Listagem de Contatos

Cadastrar um Contato

Obter um Contato

Atualizar um Contato

Excluir um Contato