👥 Contatos API

API completa para gestão de contatos, clientes e relacionamentos com dados personalizados.

✨ CRM Completo

Gerencie todos os dados dos seus clientes com campos customizados e integrações.

Introdução

O módulo de Contatos é o coração da gestão de relacionamento com clientes. Permite:

  • Criar e gerenciar perfis de contatos
  • Buscar e filtrar contatos avançadamente
  • Importar contatos em massa (CSV/Excel)
  • Adicionar campos personalizados
  • Organizar com tags e segmentação
  • Integrar com WhatsApp, e-mail e outros canais

Gestão de Contatos

Endpoints para CRUD completo de contatos.

GET

/v1/contacts

Listar contatos

POST

/v1/contacts

Criar contato

GET

/v1/contacts/{id}

Obter detalhes do contato

PATCH

/v1/contacts/{id}

Atualizar contato

DELETE

/v1/contacts/{id}

Excluir contato

Exemplo: Criar contato 
const response = await fetch(
  'https://api.atys.pro/v1/contacts',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: JSON.stringify({
      name: 'Maria Silva',
      email: 'maria@example.com',
      phone: '+5511999999999',
      document: '12345678900', // CPF
      company_name: 'Empresa ABC',
      address: {
        street: 'Rua Exemplo',
        number: '123',
        city: 'São Paulo',
        state: 'SP',
        zip_code: '01234-567'
      },
      custom_fields: {
        cargo: 'Gerente de TI',
        empresa_size: '50-100',
        interesse: 'CRM'
      }
    })
  }
);

const contact = await response.json();
console.log('Contato criado:', contact.data.id);

A API de Contatos suporta busca avançada e múltiplos filtros.

🔍 Parâmetros de busca disponíveis:
  • q - Busca por nome, email ou telefone
  • email - Filtrar por email específico
  • phone - Filtrar por telefone
  • document - Filtrar por CPF/CNPJ
  • created_after - Criados após data
  • created_before - Criados antes de data
  • tags - Filtrar por tags (separadas por vírgula)
  • sort - Ordenar (-created_at, name, etc)
Exemplo: Busca avançada 
# Buscar por nome
curl 'https://api.atys.pro/v1/contacts?q=maria&sort=-created_at' \
  -H 'Authorization: Bearer YOUR_API_KEY'

# Filtrar por tags
curl 'https://api.atys.pro/v1/contacts?tags=cliente,vip&per_page=25' \
  -H 'Authorization: Bearer YOUR_API_KEY'

# Contatos criados em 2025
curl 'https://api.atys.pro/v1/contacts?created_after=2025-01-01&created_before=2025-12-31' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Importação de Contatos

Importe milhares de contatos de uma vez usando CSV ou Excel.

POST

/v1/import-contacts

Iniciar importação

GET

/v1/import-contacts/{importId}/status

Verificar status da importação

Exemplo: Importar CSV 
// 1. Preparar arquivo CSV
const csvFile = new File([csvContent], 'contatos.csv', {
  type: 'text/csv'
});

// 2. Enviar para importação
const formData = new FormData();
formData.append('file', csvFile);
formData.append('has_header', 'true');
formData.append('mapping', JSON.stringify({
  name: 'Nome',
  email: 'E-mail',
  phone: 'Telefone'
}));

const response = await fetch(
  'https://api.atys.pro/v1/import-contacts',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: formData
  }
);

const importJob = await response.json();

// 3. Verificar status
const checkStatus = async (jobId) => {
  const status = await fetch(
    `https://api.atys.pro/v1/import-contacts/${jobId}/status`,
    {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
      }
    }
  );
  return await status.json();
};

Campos Customizados

Adicione campos personalizados aos seus contatos para armazenar qualquer tipo de informação.

GET

/v1/dynamic-datas

Listar campos customizados

POST

/v1/dynamic-datas

Criar campo customizado

Exemplo: Criar campo customizado 
const response = await fetch(
  'https://api.atys.pro/v1/dynamic-datas',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: JSON.stringify({
      name: 'Data de Nascimento',
      key: 'birth_date',
      type: 'date',
      is_required: false,
      options: null // Para selects, array de opções
    })
  }
);
📊 Tipos de campos suportados:
  • text - Texto simples
  • number - Número
  • date - Data
  • select - Seleção única
  • multi-select - Seleção múltipla
  • boolean - Sim/Não
  • email - E-mail
  • phone - Telefone
  • url - URL

Tags

Organize contatos com tags para segmentação e filtros.

GET

/v1/tags

Listar tags

POST

/v1/tags

Criar tag

Webhooks Disponíveis

  • contact.created - Contato criado
  • contact.updated - Contato atualizado
  • contact.merged - Contatos mesclados
  • contact.deleted - Contato excluído
  • contact.import.completed - Importação concluída

Esta página foi útil?

← Tickets API
CRM API →