Modelo de colunas do CSV

GET

/api/v2/crm/data_imports/csv_example

Devolve o cabeçalho que o CSV de importação precisa ter, montado a partir
dos campos do template e das tabelas relacionadas a ele. É o mesmo modelo que o
Cockpit baixa na tela Configurações › Base de dados.

Cada coluna vem prefixada pelo nome da tabela (cliente.nome, contato.telefone),
o que permite importar a tabela raiz e suas relacionadas no mesmo arquivo.

Use pra:

Descobrir exatamente quais colunas o arquivo deve ter, e em que ordem

Montar o CSV programaticamente, sem depender de um modelo baixado à mão

Passe template_id ou root_table_id. Com template_id, a tabela raiz é
resolvida a partir do próprio template.

Requisição

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200OK

application/json

Cabeçalho do CSV e as tabelas envolvidas.

Bodyapplication/json

🟠400Pedido Inválido

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🔴500Erro Interno

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v2/crm/data_imports/csv_example?template_id=26cd301a-5c82-468b-9c23-af3c915d9720&root_table_id=undefined&separator=%3B' \
--header 'api-key: {{api-key}}'

Response Example

200 - Modelo da tabela `cliente`

{
    "header": "cliente.nome;cliente.cpf_cnpj;cliente.email;contato.telefone;contato.tipo",
    "separator": ";",
    "root_table": "cliente",
    "related_tables": [
        "Contato"
    ]
}

Modificado em 2026-11-04 02:31:07

Página anterior

Listar templates de RCS

Próxima página

Importar base (CSV) para uma tabela do CRM