{ "openapi": "3.1.0", "info": { "title": "C2S API — Contact2Sale Integration API", "description": "Documentação OpenAPI da API de integração da Contact2Sale (C2S). Permite gerenciar leads, usuários, empresas, tags, webhooks, blocklist, stand de vendas e filas de distribuição.", "version": "1.0.0", "contact": { "name": "Contact2Sale", "url": "https://www.contact2sale.com/" } }, "externalDocs": { "description": "Documentação completa em texto puro (Markdown)", "url": "https://docs-api-leads.c2sapp.com/llms-full.txt" }, "servers": [ { "url": "https://api.contact2sale.com/integration" } ], "tags": [ { "name": "Informações Gerais", "description": "Retorna informações da empresa autenticada." }, { "name": "Leads", "description": "Endpoints para criação, atualização, encaminhamento, tags, interação e fechamento de leads." }, { "name": "Usuários", "description": "Endpoints para gerenciamento de vendedores." }, { "name": "Empresas", "description": "Endpoints para listar empresas do grupo (filiais)." }, { "name": "Tags", "description": "Endpoints para gerenciamento de tags." }, { "name": "Regras de Distribuição", "description": "Endpoints para gerenciamento de regras de distribuição (regiões)." }, { "name": "Filas de Distribuição", "description": "Endpoints para gerenciamento de filas de distribuição." }, { "name": "Webhooks", "description": "Endpoints para gerenciamento de **webhooks**, que permitem receber automaticamente as informações dos leads em tempo real através de gatilhos configuráveis.\n\nCom os webhooks, seu sistema será notificado sempre que um lead for criado, atualizado ou encerrado — sem necessidade de consultar a API periodicamente." }, { "name": "Stand de Vendas", "description": "Endpoints para acesso a dados do módulo de Estande de Vendas. ⚠️ Esses endpoints só funcionam caso a função de Stand de Vendas esteja ativa na sua conta.\n\n**Fluxo recomendado:**\n1. `GET /stands` → descobre os IDs de estandes e formulários\n2. `GET /leads` → lista leads filtrando por `custom_lead_form_id` (do passo 1)\n3. `GET /attendance_summaries` → lista presenças filtrando por `sales_stand_id` (do passo 1)\n\n⚠️ Todos os IDs retornados pela API são criptografados e devem ser enviados como recebidos nos parâmetros de filtro. Nunca use IDs numéricos diretos." }, { "name": "Blocklist", "description": "Endpoints para gerenciamento da blocklist de contatos da hierarquia. ⚠️ Esses endpoints só funcionam caso a função de \"Hierarquia\" esteja ativa na sua conta." } ], "paths": { "/sales_stand/stands": { "get": { "operationId": "listar_estandes_get", "summary": "Listar Estandes", "description": "Lista os estandes de vendas (filas de distribuição com regra de estande) acessíveis pela hierarquia da empresa autenticada, com o formulário de atendimento associado a cada um.", "tags": [ "Stand de Vendas" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação gerado no C2S", "schema": { "type": "string" }, "example": "Bearer " }, { "name": "company_ids[]", "required": false, "description": "Filtra por empresas específicas da hierarquia. Se omitido, retorna estandes de toda a hierarquia.", "schema": { "type": "array", "items": { "type": "string" }, "example": "company_ids[]=abc123" }, "in": "query" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "data": [ { "id": 123, "name": "Nome do Estande", "company_id": "", "company_name": "Nome da Empresa", "custom_lead_form_id": 456, "created_at": "2025-01-15T10:00:00.000-03:00", "updated_at": "2025-01-16T14:30:00.000-03:00" } ] } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } } }, "/me": { "get": { "operationId": "informa__es_da_empresa_get", "summary": "Informações da Empresa", "description": "Retorna informações da empresa autenticada e suas sub-empresas.", "tags": [ "Informações Gerais" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "company_name": "Empresa Exemplo", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "sub_companies": [ { "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "company_name": "Empresa Exemplo" }, { "company_id": "d6c5b4a3f2e1d0c9b8a7f6e5d4c3b2a1", "company_name": "Empresa Exemplo - Filial 2" } ] } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } } }, "/companies": { "get": { "operationId": "listar_empresas_get", "summary": "Listar Empresas", "description": "Lista todas as empresas do grupo (filiais) da empresa autenticada.", "tags": [ "Empresas" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": [ { "id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "name": "Empresa Exemplo" }, { "id": "d6c5b4a3f2e1d0c9b8a7f6e5d4c3b2a1", "name": "Empresa Exemplo - Filial 2" }, { "id": "e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2", "name": "Empresa Exemplo - Filial 3" } ] } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } } }, "/distribution_queues/list_queues": { "get": { "operationId": "listar_filas_de_distribui__o_get", "summary": "Listar Filas de Distribuição", "description": "Lista as filas de distribuição da empresa pai. Retorna headers de paginação: Total-pages, Total-entries, Current-page.", "tags": [ "Filas de Distribuição" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "page", "required": false, "description": "Número da página", "schema": { "type": "integer", "example": 1 }, "in": "query" }, { "name": "per_page", "required": false, "description": "Itens por página", "schema": { "type": "integer", "example": 25 }, "in": "query" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "distribution_queues": [ { "id": 12345, "name": "Fila Principal", "priority": 10, "status": "enabled", "queue_type": "custom_queue", "leads_count": 0, "redistributable_leads_count": null, "redistributable": false, "check_in": false, "check_in_qr_code": false, "group_memory_lead": false, "receptionist_enabled": false, "today_working_time": { "begin": "08:00", "end": "18:00", "enable": true }, "sales_stand_form_id": null, "advanced_queue_edit": false, "rules": [ { "field": "type_negotiation", "operator": "equal", "value": "Compra" } ], "next_seller_index": 1, "next_seller": { "id": 67890, "seller_id": 11111, "seller_name": "Maria Vendedora", "company_id": 2776, "company_name": "Empresa Exemplo", "priority": 1, "status": "enabled", "repeated_on_queue": false, "count_on_queue": 1, "first_check_in_at": null, "last_check_out_at": null, "checked_in_after_shuffle": false, "own_hierarchy_name": "Empresa Exemplo", "closest_parent_hierarchy_name": null, "level_one_parent_hierarchy_name": null }, "distribution_sellers_quantity": 3 }, { "id": 12346, "name": "Fila Check-in", "priority": 9, "status": "enabled", "queue_type": "custom_queue", "leads_count": 0, "redistributable_leads_count": null, "redistributable": false, "check_in": true, "check_in_qr_code": true, "group_memory_lead": false, "receptionist_enabled": false, "today_working_time": { "begin": "00:00", "end": "23:59", "enable": true }, "sales_stand_form_id": null, "advanced_queue_edit": false, "rules": [], "next_seller_index": 0, "next_seller": {}, "distribution_sellers_quantity": 0 } ] } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } } }, "/distribution_rules": { "get": { "operationId": "listar_regras_de_distribui__o_get", "summary": "Listar Regras de Distribuição", "description": "Lista todas as regras de distribuição (regiões) da empresa e suas filiais.", "tags": [ "Regras de Distribuição" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": [ { "cod_1": "ABC123", "cod_2": "Empreendimento Centro", "cod_3": "", "priority": 1, "type_rule": "distribution", "seller_id": "s1e2l3l4e5r6i7d8e9x0e1m2p3l4o5f6", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" }, { "cod_1": "DEF456", "cod_2": "Empreendimento Sul", "cod_3": "Compra", "priority": 1, "type_rule": "distribution", "seller_id": "s2e3l4l5e6r7i8d9e0x1e2m3p4l5o6f7", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" }, { "cod_1": null, "cod_2": null, "cod_3": "Compra", "priority": 1, "type_rule": "rotation", "seller_id": "s3e4l5l6e7r8i9d0e1x2e3m4p5l6o7f8", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" }, { "cod_1": null, "cod_2": null, "cod_3": "Aluguel", "priority": 1, "type_rule": "rotation", "seller_id": "s3e4l5l6e7r8i9d0e1x2e3m4p5l6o7f8", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" } ] } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } }, "post": { "operationId": "criar_regra_de_distribui__o_post", "summary": "Criar Regra de Distribuição", "description": "Cria uma nova regra de distribuição.", "tags": [ "Regras de Distribuição" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "201": { "description": "Resposta esperada", "content": { "application/json": { "example": { "message": "Distribution rule created successfully" } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "cod_1": "SP", "cod_2": "São Paulo", "cod_3": "Centro", "priority": 1, "type_rule": "rotation", "seller_id": "", "company_id": "" } } } } } }, "/hierarchy_blocklists": { "get": { "operationId": "listar_blocklist_get", "summary": "Listar Blocklist", "description": "Lista todas as entradas da blocklist da hierarquia da empresa autenticada, ordenadas pela mais recente.\n\nO escopo é sempre a hierarquia da empresa autenticada (determinado via `top_hierarchy_company`).", "tags": [ "Blocklist" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação gerado no C2S", "schema": { "type": "string" }, "example": "" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "blocklists": [ { "id": 789, "phone": "5511999999999", "email": null, "top_parent_company_id": "", "created_at": "2025-01-15T10:00:00.000-03:00", "updated_at": "2025-01-15T10:00:00.000-03:00" }, { "id": 788, "phone": null, "email": "bloqueado@exemplo.com", "top_parent_company_id": "", "created_at": "2025-01-14T10:00:00.000-03:00", "updated_at": "2025-01-14T10:00:00.000-03:00" } ] } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } }, "post": { "operationId": "adicionar___blocklist_post", "summary": "Adicionar à Blocklist", "description": "Adiciona um telefone e/ou e-mail à blocklist da hierarquia. Ao ser criada, a entrada impede que novos leads com esse contato sejam distribuídos dentro da hierarquia.\n\n**Campos do body:**\n- `phone` (condicional) — Telefone do contato. Será normalizado (formato E.164 com variações).\n- `email` (condicional) — E-mail do contato. Será normalizado (lowercase + trim).\n- `remove_leads` (opcional, default: false) — Se `true`, dispara worker assíncrono para remover/redistribuir leads existentes que correspondam ao contato bloqueado. Se `false`, apenas registra o audit log.\n\n*Pelo menos um dos dois (`phone` ou `email`) deve ser enviado.*\n\n**Verificação de duplicidade:** O sistema verifica se já existe uma entrada com o mesmo telefone (considerando variações de formatação) ou e-mail na hierarquia. Se existir, retorna **409 Conflict**.\n\n**Notas:**\n- O campo `phone` passa por normalização automática cobrindo variações de DDD/DDI.\n- Enviar `11999998888` ou `+5511999998888` produz o mesmo resultado de conflito.\n\n**Respostas possíveis:**\n- `201` — Entrada criada com sucesso.\n- `409` — Já existe um registro com esse telefone/e-mail na hierarquia.\n- `422` — Falha de validação ou erro inesperado.", "tags": [ "Blocklist" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação gerado no C2S", "schema": { "type": "string" }, "example": "" }, { "name": "Content-Type", "in": "header", "required": false, "description": "Tipo do conteúdo", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "201": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": 11999998888 }, "email": { "type": "string", "example": "contato@empresa.com" }, "remove_leads": { "type": "boolean", "example": true } } }, "example": { "hierarchy_blocklist": { "phone": "11999998888", "email": "contato@empresa.com", "remove_leads": true } } } } } } }, "/api/subscribe": { "post": { "operationId": "assinar_webhook_post", "summary": "Assinar Webhook", "description": "Assina eventos de webhook para leads. Ações disponíveis: **on_create_lead**, **on_update_lead**, **on_close_lead**.\n\n**Gatilhos disponíveis:**\n- **on_create_lead** — Envia as informações do lead no momento em que ele é criado.\n- **on_update_lead** — Envia as informações do lead quando é gerado um log de alteração dentro dele.\n- **on_close_lead** — Envia as informações do lead quando ele é arquivado ou o negócio é fechado com o cliente.\n\n⚠️ **Importante:** Só é possível cadastrar **1 endpoint por token** utilizado. Caso um segundo endpoint seja cadastrado, o primeiro será **automaticamente apagado**.\n\nÉ possível utilizar os **3 gatilhos em um mesmo endpoint** — basta enviar uma requisição de assinatura para cada ação desejada.", "tags": [ "Webhooks" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "message": "Subscribed successfully" } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "hook_action": "on_create_lead", "hook_url": "https://seu-servidor.com/webhook" } } } } } }, "/sellers": { "get": { "operationId": "listar_vendedores_get", "summary": "Listar Vendedores", "description": "Lista todos os vendedores da empresa autenticada (incluindo empresas do grupo).", "tags": [ "Usuários" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": [ { "id": "s1e2l3l4e5r6i7d8e9x0e1m2p3l4o5f6", "name": "Maria Vendedora", "email": "maria@empresa.com", "phone": "5511988888888", "company": "Empresa Exemplo", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "is_recipient": 1, "can_view_bucket": true, "external_id": "", "external_name": "", "is_master": true }, { "id": "s2e3l4l5e6r7i8d9e0x1e2m3p4l5o6f7", "name": "Carlos Corretor", "email": "carlos@empresa.com", "phone": "5511977777777", "company": "Empresa Exemplo", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "is_recipient": 0, "can_view_bucket": true, "external_id": null, "external_name": null, "is_master": false }, { "id": "s3e4l5l6e7r8i9d0e1x2e3m4p5l6o7f8", "name": "Ana Gestora", "email": "ana@empresa.com", "phone": "5511966666666", "company": "Empresa Exemplo", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "is_recipient": 4, "can_view_bucket": true, "external_id": "12345", "external_name": "Nome Externo", "is_master": false } ] } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } }, "post": { "operationId": "criar_vendedor_post", "summary": "Criar Vendedor", "description": "Cria um novo vendedor.", "tags": [ "Usuários" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "201": { "description": "Resposta esperada", "content": { "application/json": { "example": { "id": "s1e2l3l4e5r6i7d8e9x0e1m2p3l4o5f6", "name": "Novo Vendedor", "email": "vendedor@empresa.com", "phone": "5511999999999", "company": "Empresa Exemplo", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "is_recipient": 1, "can_view_bucket": true, "external_id": "EXT-001", "external_name": null, "is_master": false } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "company_id": "", "name": "Novo Vendedor", "username": "novovendedor", "email": "vendedor@exemplo.com", "phone1": "11999999999", "is_recipient": true, "is_rescue": false, "is_master": false, "can_access_users": false, "show_in_metrics": true, "external_id": "EXT-001", "own_captations_aux": [ 0, 1 ], "team": [ 0, 1, 2 ] } } } } } }, "/tags": { "get": { "operationId": "listar_tags_get", "summary": "Listar Tags", "description": "Lista as tags da empresa autenticada.", "tags": [ "Tags" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "name", "required": false, "description": "Filtrar pelo nome exato da tag", "schema": { "type": "string" }, "in": "query" }, { "name": "autofill", "required": false, "description": "Filtrar pela flag de autofill", "schema": { "type": "boolean", "example": false }, "in": "query" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "data": [ { "id": "t1a2g3i4d5e6x7e8m9p0l1o2f3o4r5m6", "type": "tag", "attributes": { "id": "t1a2g3i4d5e6x7e8m9p0l1o2f3o4r5m6", "name": "Quente", "enabled": true, "autofill": false, "instructions": null } }, { "id": "t2a3g4i5d6e7x8e9m0p1l2o3f4o5r6m7", "type": "tag", "attributes": { "id": "t2a3g4i5d6e7x8e9m0p1l2o3f4o5r6m7", "name": "Frio", "enabled": true, "autofill": false, "instructions": null } }, { "id": "t3a4g5i6d7e8x9e0m1p2l3o4f5o6r7m8", "type": "tag", "attributes": { "id": "t3a4g5i6d7e8x9e0m1p2l3o4f5o6r7m8", "name": "Investidor", "enabled": true, "autofill": true, "instructions": "Aplicar quando o cliente demonstrar interesse em investimento" } }, { "id": "t4a5g6i7d8e9x0e1m2p3l4o5f6o7r8m9", "type": "tag", "attributes": { "id": "t4a5g6i7d8e9x0e1m2p3l4o5f6o7r8m9", "name": "Financiamento", "enabled": true, "autofill": false, "instructions": null } } ] } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } }, "post": { "operationId": "criar_tag_post", "summary": "Criar Tag", "description": "Cria uma nova tag. Se uma tag com os mesmos parâmetros já existir, retorna a tag existente com status 201 e uma chave errors.", "tags": [ "Tags" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "201": { "description": "Resposta esperada", "content": { "application/json": { "example": { "tag": { "id": "t1a2g3i4d5e6x7e8m9p0l1o2f3o4r5m6", "name": "Nova Tag", "enabled": true, "company_id": 2776, "created_by_seller_id": 12345, "edited_by_seller_id": null, "created_at": "2026-04-16T12:00:00.000-03:00", "updated_at": "2026-04-16T12:00:00.000-03:00", "autofill": false, "instructions": null } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "tag": { "name": "Nova Tag", "autofill": false, "instructions": "Instruções para IA de autofill" } } } } } } }, "/leads": { "get": { "operationId": "listar_leads_get", "summary": "Listar Leads", "description": "Lista leads da empresa autenticada com filtros e paginação.", "tags": [ "Leads" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "page", "required": false, "description": "Número da página", "schema": { "type": "integer", "example": 1 }, "in": "query" }, { "name": "perpage", "required": false, "description": "Itens por página (máximo 50)", "schema": { "type": "integer", "example": 25 }, "in": "query" }, { "name": "sort", "required": false, "description": "Campo de ordenação. Aceita created_at, updated_at. Prefixo - para DESC", "schema": { "type": "string", "example": "-created_at" }, "in": "query" }, { "name": "last_update", "required": false, "description": "Filtro por datetime ISO 8601. Retorna leads atualizados desde esta data", "schema": { "type": "string" }, "in": "query" }, { "name": "created_gte", "required": false, "description": "Leads criados a partir desta data (inclusive)", "schema": { "type": "string" }, "in": "query" }, { "name": "created_lt", "required": false, "description": "Leads criados antes desta data", "schema": { "type": "string" }, "in": "query" }, { "name": "updated_gte", "required": false, "description": "Leads atualizados a partir desta data (inclusive)", "schema": { "type": "string" }, "in": "query" }, { "name": "updated_lt", "required": false, "description": "Leads atualizados antes desta data", "schema": { "type": "string" }, "in": "query" }, { "name": "status", "required": false, "description": "Filtrar por status: novo, em_negociacao, convertido, negocio_fechado, arquivado, resgatado, pendente, recusado, finalizado", "schema": { "type": "string" }, "in": "query" }, { "name": "tags", "required": false, "description": "Nomes de tags separados por vírgula", "schema": { "type": "string" }, "in": "query" }, { "name": "phone", "required": false, "description": "Filtrar pelo telefone do cliente", "schema": { "type": "string" }, "in": "query" }, { "name": "email", "required": false, "description": "Filtrar pelo email do cliente", "schema": { "type": "string" }, "in": "query" }, { "name": "first_message", "required": false, "description": "Incluir primeira mensagem na resposta", "schema": { "type": "boolean" }, "in": "query" }, { "name": "custom_attributes", "required": false, "description": "Incluir atributos customizados na resposta", "schema": { "type": "boolean" }, "in": "query" }, { "name": "from_hierarchy_company", "required": false, "description": "Se true, inclui no lead o campo from_hierarchy_company com o nome da hierarquia (empresa) que gerou o lead. Retorna null caso a hierarquia que gerou seja a mesma que recebeu o lead, ou caso a empresa não utilize hierarquia.", "schema": { "type": "boolean", "example": true }, "in": "query" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "data": [ { "type": "lead", "id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "internal_id": 12345678, "attributes": { "description": "Apartamento 3 quartos", "observation": "17 de Abril, 10:00 de 2026 - Retornar contato", "is_favorite": false, "product": { "id": "p1r2o3d4u5c6t7i8d9e0x1e2m3p4l5o6", "description": "[101] Apartamento 3 quartos", "prop_ref": "101", "price_float": 350000.0, "price": "350.000,00", "neighbourhood": "Centro", "city": "São Paulo", "real_estate_detail": { "negotiation_name": "Compra" }, "model": null, "brand": null, "year": null, "version": null, "license_plate": null }, "customer": { "id": "c1u2s3t4o5m6e7r8i9d0e1x2e3m4p5l6", "name": "João Silva", "email": "joao.silva@email.com", "phone": "5511999999999", "phone2": null, "phone_global": "+5511999999999" }, "seller": { "id": "s1e2l3l4e5r6i7d8e9x0e1m2p3l4o5f6", "name": "Maria Vendedora", "email": "maria@empresa.com", "phone": "5511988888888", "company": "Empresa Exemplo", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "is_recipient": 1, "can_view_bucket": true, "external_id": "", "external_name": null }, "collaborators": [], "created_by": { "id": "c1r2e3a4t5e6d7b8y9i0d1e2x3e4m5p6", "name": "Admin Sistema", "email": "admin@empresa.com", "phone": "5511977777777", "company": "Empresa Exemplo", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "is_recipient": 0, "can_view_bucket": true, "external_id": null, "external_name": null }, "company": { "id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "name": "Empresa Exemplo", "language": "pt-BR" }, "lead_source": { "id": 542, "name": "Ação de Rua" }, "channel": { "id": 2, "name": "Showroom" }, "lost_reasons": { "name": null }, "lead_status": { "id": 1, "alias": "under_negotiation", "name": "Em negociação" }, "funnel_status": { "status": "In attendance" }, "done_details": { "done": false, "done_details": null, "done_price": null }, "archive_details": { "archived": false, "archive_notes": null }, "tags": [], "log": [ { "body": "Lead marcado como interagido pelo WhatsApp pelo usuário Admin Sistema", "created_at": "2026-04-16T11:41:53.608-03:00" }, { "body": "Lead criado por Admin Sistema para Maria Vendedora", "created_at": "2026-04-16T11:40:27.227-03:00" } ], "messages": [], "schedulated_actions": [], "created_at": "2026-04-16T11:40:26.000-03:00", "updated_at": "2026-04-16T11:41:52.000-03:00", "external_created_at": null, "from_hierarchy_company": "Imobiliária Matriz SP", "last_activity_date": "2026-04-17T10:00:00.000-03:00", "read_at": "2026-04-16T11:41:52.000-03:00", "replied_at": null, "done_deal_at": null, "url": "", "demo_company": false }, "schedulated_actions": [ { "id": "a1c2t3i4o5n6i7d8e9x0e1m2p3l4o5f6", "seller_id": "s1e2l3l4e5r6i7d8e9x0e1m2p3l4o5f6", "seller_name": "Maria Vendedora", "schedulated_action_type_id": 6, "schedulated_action_type_alias": "first_contact", "schedulated_action_name": "Primeiro contato", "schedulated_action_date": "2026-04-16T11:50:26.000-03:00", "description": null, "created_at": "2026-04-16T11:40:26.000-03:00", "status": "Finalizado sem informar" } ], "messages": [ { "id": "m1e2s3s4a5g6e7i8d9e0x1e2m3p4l5o6", "sender_id": "c1r2e3a4t5e6d7b8y9i0d1e2x3e4m5p6", "recipient_id": "c1u2s3t4o5m6e7r8i9d0e1x2e3m4p5l6", "sender_type": "Seller", "recipient_type": "Customer", "body": "Bom dia! Como posso ajudar?", "created_at": "2026-04-16T11:41:52.000-03:00", "updated_at": "2026-04-16T11:41:52.000-03:00", "read_at": "2026-04-16T11:41:52.000-03:00" } ], "facebook_attributes": {} } ], "pagination": { "current_page": 1, "per_page": 50, "total_count": 150, "total_pages": 3 } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } }, "post": { "operationId": "criar_lead_post", "summary": "Criar Lead", "description": "Cria um novo lead. É obrigatório enviar ao menos phone ou email (caso contrário retorna 423).", "tags": [ "Leads" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "lead_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "received_by": { "id": "s1e2l3l4e5r6i7d8e9x0e1m2p3l4o5f6", "name": "Maria Vendedora", "email": "maria@empresa.com", "phone": "5511988888888" }, "company": "Empresa Exemplo", "info": { "name": "João Silva", "email": "joao.silva@email.com", "phone": "5511999999999", "channel_id": 1, "lead_source_id": 1, "message": "Interesse no imóvel X" } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "phone2": { "type": "string" }, "description": { "type": "string" }, "prop_ref": { "type": "string" }, "brand": { "type": "string" }, "model": { "type": "string" }, "version": { "type": "string" }, "year": { "type": "integer" }, "price": { "type": "string" }, "color": { "type": "string" }, "km": { "type": "integer" }, "license_plate": { "type": "string" }, "type_negotiation_string": { "type": "string" }, "type_negotiation": { "type": "string" }, "vehicle_type": { "type": "string" }, "city": { "type": "string" }, "neighbourhood": { "type": "string" }, "channel_id": { "type": "integer" }, "channel_abbrev": { "type": "string" }, "url": { "type": "string" }, "sourcerUrl": { "type": "string" }, "body": { "type": "string" }, "observation": { "type": "string" }, "external_id": { "type": "string" }, "custom_created_at": { "type": "string" }, "pending": { "type": "boolean" }, "closed": { "type": "boolean" }, "already_interacted": { "type": "boolean" }, "skip_on_interaction": { "type": "boolean" }, "source": { "type": "string" }, "real_state_keywords": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "tag_name": { "type": "string" }, "wpp_username": { "type": "string" }, "bsuid": { "type": "string" } } }, "example": "{\n \"data\": {\n \"type\": \"lead\",\n \"attributes\": {\n\n // ============================================================\n // IDENTIFICAÇÃO DO CLIENTE (Customer)\n // ============================================================\n\n // Nome do cliente.\n // Default: \"Não identificado\"\n \"name\": \"Pedro Silva\",\n\n // Email do cliente.\n // Utilizado para deduplicação.\n // Remove \".\" antes do @ automaticamente.\n \"email\": \"pedro@teste.com\",\n\n // Telefone principal.\n // Se vazio, usa \"customer_number\" como fallback.\n \"phone\": \"+55 11 99999-9999\",\n\n // Telefone secundário (opcional).\n \"phone2\": \"+55 11 99999-9999\",\n\n\n // ============================================================\n // PRODUTO / IMÓVEL / VEÍCULO (Product)\n // ============================================================\n\n // Descrição principal do item.\n // Exibida no card do lead.\n // Máximo: 250 caracteres.\n \"description\": \"Apartamento 2 quartos no Botafogo\",\n\n // Código do imóvel.\n // Obrigatório para empresas do tipo IMOBILIÁRIA.\n // Valores especiais:\n // \"Sem código\", \"Não localizado\", \"Nenhum\", \"ignore\"\n \"prop_ref\": \"AP12345\",\n\n // Marca do veículo.\n // Apenas empresas de CARROS ou MOTOS.\n \"brand\": \"Volkswagen\",\n\n // Modelo do veículo.\n // Apenas empresas de CARROS ou MOTOS.\n \"model\": \"Polo\",\n\n // Versão do veículo.\n // Apenas empresas de CARROS ou MOTOS.\n \"version\": \"Comfortline 1.6\",\n\n // Ano do veículo.\n // Se igual ao ano atual, pode virar \"Novo\".\n \"year\": 2024,\n\n // Valor do produto/imóvel/veículo.\n // Aceita:\n // \"R$ 250.000,00\"\n // \"250000\"\n // \"250000.00\"\n \"price\": \"R$ 250.000,00\",\n\n // Cor do veículo.\n // Apenas empresas de CARROS ou MOTOS.\n \"color\": \"Prata\",\n\n // Quilometragem.\n // Se 0 => força vehicle_type = \"Novo\"\n // Apenas empresas de CARROS ou MOTOS.\n \"km\": 35000,\n\n // Placa do veículo.\n // Removida automaticamente da descrição.\n // Apenas empresas de CARROS ou MOTOS.\n \"license_plate\": \"ABC1D23\",\n\n // Texto livre da negociação.\n // Faz parser automático de palavras-chave.\n // Evite usar junto com \"type_negotiation\".\n \"type_negotiation_string\": \"Apartamento para Aluguel por R$ 1.200,00\",\n\n // Tipo de negociação.\n // Apenas IMOBILIÁRIAS.\n // Exemplos:\n // \"Comprar\"\n // \"Alugar\"\n // \"Lançamento\"\n \"type_negotiation\": \"Comprar\",\n\n // Tipo do veículo.\n // Valores comuns:\n // \"Novo\"\n // \"Usado\"\n // Apenas empresas de CARROS ou MOTOS.\n \"vehicle_type\": \"Usado\",\n\n // Cidade do imóvel.\n // Utilizada na distribuição.\n \"city\": \"Campinas\",\n\n // Bairro do imóvel.\n // Utilizado na distribuição.\n \"neighbourhood\": \"Botafogo\",\n\n\n // ============================================================\n // LEAD\n // ============================================================\n\n // ID do canal.\n // Valores possíveis:\n // [1,2,3,4,5]\n // Default: 1 (Internet)\n \"channel_id\": 1,\n\n // Abreviação do canal.\n // Exemplos:\n // \"internet\"\n // \"whatsapp\"\n // \"telefone\"\n // \"showroom\"\n \"channel_abbrev\": \"internet\",\n\n // URL do anúncio/origem.\n // Se vazio e existir prop_ref + custom_link,\n // a URL pode ser gerada automaticamente.\n \"url\": \"https://exemplo.com.br/imovel/12345\",\n\n // Campo legado de URL.\n // Alguns parceiros ainda enviam aqui.\n \"sourcerUrl\": \"https://exemplo.com.br/imovel/12345\",\n\n // Primeira mensagem do lead.\n // Máximo: 15.000 caracteres.\n // Aceita HTML.\n \"body\": \"Olá, tenho interesse no imóvel.\",\n\n // Observação interna.\n \"observation\": \"Cliente VIP, retornar com prioridade\",\n\n // ID externo do parceiro.\n // Pode ser usado em distribuições específicas.\n \"external_id\": \"EXT-99887\",\n\n // Sobrescreve o created_at do lead.\n // Timezone da empresa é respeitada.\n \"custom_created_at\": \"2026-05-08T14:30:00\",\n\n\n // ============================================================\n // ORIGEM / DISTRIBUIÇÃO\n // ============================================================\n\n // Estado do lead.\n // true => pendente (distribuível)\n // false => já distribuído ou fechado\n \"pending\": true,\n\n // Lead já fechado.\n \"closed\": false,\n\n // Já houve interação com o lead.\n \"already_interacted\": false,\n\n // Pular na distribuição se já interagido.\n \"skip_on_interaction\": false,\n\n // Fonte primária da origem.\n // Exemplos:\n // \"portal_zap\"\n // \"facebook\"\n // \"google_ads\"\n \"source\": \"portal_zap\",\n\n // Palavras-chave para imobiliárias.\n // Exemplos:\n // \"aluguel\"\n // \"venda\"\n // \"lançamento\"\n \"real_state_keywords\": [\"aluguel\", \"venda\"],\n\n // IDs das tags do lead.\n // Exemplo: [\"tag-uuid-1\", \"tag-uuid-2\"]\n \"tags\": [\"tag-uuid-1\"],\n\n // Nome da tag (usado em integrações legadas).\n // Exemplo: \"imoveis\", \"premium\"\n \"tag_name\": \"imoveis\",\n\n\n // ============================================================\n // WHATSAPP / EXTRAS\n // ============================================================\n\n // Username/número do WhatsApp.\n \"wpp_username\": \"5511903873417\",\n\n // Business Account UID do WhatsApp.\n \"bsuid\": \"1234567890\"\n }\n }\n}" } } } } }, "/distribution_queues/:id/sellers": { "get": { "operationId": "listar_vendedores_da_fila_get", "summary": "Listar Vendedores da Fila", "description": "Lista os vendedores de uma fila de distribuição. Inclui headers de paginação.", "tags": [ "Filas de Distribuição" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "id", "required": true, "description": "ID da fila de distribuição", "schema": { "type": "integer" }, "in": "query" }, { "name": "page", "required": false, "description": "Número da página", "schema": { "type": "integer", "example": 1 }, "in": "query" }, { "name": "per_page", "required": false, "description": "Itens por página", "schema": { "type": "integer", "example": 25 }, "in": "query" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "distribution_queue_sellers": [ { "id": 67890, "seller_id": 11111, "seller_name": "Maria Vendedora", "company_id": 2776, "company_name": "Empresa Exemplo", "priority": 1, "status": "enabled", "repeated_on_queue": false, "count_on_queue": 1, "first_check_in_at": null, "last_check_out_at": null, "checked_in_after_shuffle": false, "own_hierarchy_name": "Empresa Exemplo", "closest_parent_hierarchy_name": null, "level_one_parent_hierarchy_name": null }, { "id": 67891, "seller_id": 22222, "seller_name": "Carlos Corretor", "company_id": 2776, "company_name": "Empresa Exemplo", "priority": 2, "status": "enabled", "repeated_on_queue": false, "count_on_queue": 1, "first_check_in_at": null, "last_check_out_at": null, "checked_in_after_shuffle": false, "own_hierarchy_name": "Empresa Exemplo", "closest_parent_hierarchy_name": null, "level_one_parent_hierarchy_name": null } ] } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } } }, "/api/unsubscribe": { "post": { "operationId": "cancelar_webhook_post", "summary": "Cancelar Webhook", "description": "Cancela a assinatura de eventos de webhook.", "tags": [ "Webhooks" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "message": "Unsubscribed successfully" } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "hook_action": "on_create_lead" } } } } } }, "/sales_stand/leads": { "get": { "operationId": "listar_leads_do_estande_get", "summary": "Listar Leads do Estande", "description": "Lista os leads capturados em estandes de vendas, com paginação de 50 registros por página.", "tags": [ "Stand de Vendas" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação gerado no C2S", "schema": { "type": "string" }, "example": "Bearer " }, { "name": "start_date", "required": false, "description": "Início do período. Padrão: 1 mês atrás.", "schema": { "type": "string", "example": "2024-01-01" }, "in": "query" }, { "name": "end_date", "required": false, "description": "Fim do período. Padrão: hoje.", "schema": { "type": "string", "example": "2024-12-31" }, "in": "query" }, { "name": "custom_lead_form_ids[]", "required": false, "description": "Filtra por formulário(s) de estande. Usar os custom_lead_form.id retornados por /stands.", "schema": { "type": "array", "items": { "type": "string" }, "example": "custom_lead_form_ids[]=abc123" }, "in": "query" }, { "name": "company_ids[]", "required": false, "description": "Filtra por empresas específicas da hierarquia.", "schema": { "type": "array", "items": { "type": "string" }, "example": "company_ids[]=abc123" }, "in": "query" }, { "name": "page", "required": false, "description": "Página desejada. Padrão: 1.", "schema": { "type": "integer", "example": 1 }, "in": "query" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "data": [ { "id": "", "customer_name": "Nome do Cliente", "customer_email": "cliente@exemplo.com", "customer_phone": "11999999999", "seller_name": "Nome do Vendedor", "status": "Em negociação", "check_in_at": "2025-01-15T10:00:00.000-03:00", "check_out_at": "2025-01-15T11:00:00.000-03:00", "created_at": "2025-01-15T10:00:00.000-03:00" } ], "pagination": { "current_page": 1, "per_page": 50, "total_count": 1, "total_pages": 1 } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } } }, "/leads/:id": { "get": { "operationId": "buscar_lead_por_id_get", "summary": "Buscar Lead por ID", "description": "Retorna um lead pelo ID criptografado.", "tags": [ "Leads" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "id", "required": true, "description": "ID criptografado do lead", "schema": { "type": "string" }, "in": "query" }, { "name": "from_hierarchy_company", "required": false, "description": "Se true, inclui no lead o campo from_hierarchy_company com o nome da hierarquia (empresa) que gerou o lead. Retorna null caso a hierarquia que gerou seja a mesma que recebeu o lead, ou caso a empresa não utilize hierarquia.", "schema": { "type": "boolean", "example": true }, "in": "query" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "data": { "type": "lead", "id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "internal_id": 12345678, "attributes": { "description": "Apartamento 3 quartos", "observation": "17 de Abril, 10:00 de 2026 - Retornar contato", "is_favorite": false, "product": { "id": "p1r2o3d4u5c6t7i8d9e0x1e2m3p4l5o6", "description": "[101] Apartamento 3 quartos", "prop_ref": "101", "price_float": 350000.0, "price": "350.000,00", "neighbourhood": "Centro", "city": "São Paulo", "real_estate_detail": { "negotiation_name": "Compra" }, "model": null, "brand": null, "year": null, "version": null, "license_plate": null }, "customer": { "id": "c1u2s3t4o5m6e7r8i9d0e1x2e3m4p5l6", "name": "João Silva", "email": "joao.silva@email.com", "phone": "5511999999999", "phone2": null, "phone_global": "+5511999999999" }, "seller": { "id": "s1e2l3l4e5r6i7d8e9x0e1m2p3l4o5f6", "name": "Maria Vendedora", "email": "maria@empresa.com", "phone": "5511988888888", "company": "Empresa Exemplo", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "is_recipient": 1, "can_view_bucket": true, "external_id": "", "external_name": null }, "collaborators": [], "created_by": { "id": "c1r2e3a4t5e6d7b8y9i0d1e2x3e4m5p6", "name": "Admin Sistema", "email": "admin@empresa.com", "phone": "5511977777777", "company": "Empresa Exemplo", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "is_recipient": 0, "can_view_bucket": true, "external_id": null, "external_name": null }, "company": { "id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "name": "Empresa Exemplo", "language": "pt-BR" }, "lead_source": { "id": 542, "name": "Ação de Rua" }, "channel": { "id": 2, "name": "Showroom" }, "lost_reasons": { "name": null }, "lead_status": { "id": 1, "alias": "under_negotiation", "name": "Em negociação" }, "funnel_status": { "status": "In attendance" }, "done_details": { "done": false, "done_details": null, "done_price": null }, "archive_details": { "archived": false, "archive_notes": null }, "tags": [ { "id": "t1a2g3i4d5e6x7e8m9p0l1o2f3o4r5m6", "name": "Quente" } ], "log": [ { "body": "Lead marcado como interagido pelo WhatsApp pelo usuário Admin Sistema", "created_at": "2026-04-16T11:41:53.608-03:00" }, { "body": "Atividade criada | Retornar para o cliente | 17 de Abril, 10:00 de 2026 | Agendar visita", "created_at": "2026-04-16T11:41:10.571-03:00" }, { "body": "Lead criado por Admin Sistema para Maria Vendedora", "created_at": "2026-04-16T11:40:27.227-03:00" } ], "messages": [], "schedulated_actions": [], "created_at": "2026-04-16T11:40:26.000-03:00", "updated_at": "2026-04-16T11:41:52.000-03:00", "external_created_at": null, "from_hierarchy_company": "Imobiliária Matriz SP", "last_activity_date": "2026-04-17T10:00:00.000-03:00", "read_at": "2026-04-16T11:41:52.000-03:00", "replied_at": null, "done_deal_at": null, "url": "", "demo_company": false }, "schedulated_actions": [ { "id": "a1c2t3i4o5n6i7d8e9x0e1m2p3l4o5f6", "seller_id": "s1e2l3l4e5r6i7d8e9x0e1m2p3l4o5f6", "seller_name": "Maria Vendedora", "schedulated_action_type_id": 6, "schedulated_action_type_alias": "first_contact", "schedulated_action_name": "Primeiro contato", "schedulated_action_date": "2026-04-16T11:50:26.000-03:00", "description": null, "created_at": "2026-04-16T11:40:26.000-03:00", "status": "Finalizado sem informar" }, { "id": "a2c3t4i5o6n7i8d9e0x1e2m3p4l5o6f7", "seller_id": "s1e2l3l4e5r6i7d8e9x0e1m2p3l4o5f6", "seller_name": "Maria Vendedora", "schedulated_action_type_id": 3, "schedulated_action_type_alias": "feedback_customer", "schedulated_action_name": "Retornar para o cliente", "schedulated_action_date": "2026-04-17T10:00:00.000-03:00", "description": "Agendar visita", "created_at": "2026-04-16T11:41:10.000-03:00", "status": "Em aberto" } ], "messages": [ { "id": "m1e2s3s4a5g6e7i8d9e0x1e2m3p4l5o6", "sender_id": "c1r2e3a4t5e6d7b8y9i0d1e2x3e4m5p6", "recipient_id": "c1u2s3t4o5m6e7r8i9d0e1x2e3m4p5l6", "sender_type": "Seller", "recipient_type": "Customer", "body": "Bom dia! Como posso ajudar?", "created_at": "2026-04-16T11:41:52.000-03:00", "updated_at": "2026-04-16T11:41:52.000-03:00", "read_at": "2026-04-16T11:41:52.000-03:00" } ], "facebook_attributes": {} } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } }, "put": { "operationId": "atualizar_lead_put", "summary": "Atualizar Lead", "description": "Atualiza um lead existente. O :id é o ID criptografado do lead. Suporta 3 formatos de body: via data.attributes (legado), reset de created_at, ou atualização completa (cliente + produto + mensagem).", "tags": [ "Leads" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "lead": { "customer_id": 12345678, "product_id": 87654321, "description": "Apartamento 3 quartos", "updated_at": "2026-04-16T12:53:09.000-03:00", "company_id": 2776, "id": 12345678, "lead_source_id": 349, "channel_id": 1, "seller_id": 11111, "read_at": null, "is_favorite": false, "status": 0, "created_at": "2026-04-16T12:52:52.000-03:00", "is_rescued": false, "activity_date": "2026-04-16T13:02:52.000-03:00", "replied_at": null, "num_unread_msg_to_seller": 0, "messages": [], "related_leads": [], "lead_status": { "id": 0, "name": "Novo", "alias": "new", "color_hex": "#0000FF", "sort": 0, "restrict_change": false, "manual_change": true }, "seller": { "id": 11111, "name": "Maria Vendedora", "company_id": 2776, "company_name": "Empresa Exemplo", "username": "mariavendedora", "email": "maria@empresa.com" }, "product": { "id": 87654321, "description": "Apartamento 3 quartos", "prop_ref": "101", "brand": null, "model": null, "version": null, "year": null, "price": "350.000,00", "type_negotiation_string": "Compra" }, "customer": { "id": 12345678, "name": "João Silva", "email": "joao.silva@email.com", "phone": "11999999999", "phone2": null, "phone_formatted": "(11) 99999-9999", "whatsapp_number": "5511999999999" }, "company_name": "Empresa Exemplo", "source_name": "API / Internet", "channel_name": "Internet" } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "example": { "lead": { "channel_id": 1, "lead_source_id": 2, "url": "https://...", "customer": { "name": "Nome Atualizado", "email": "novo@email.com", "phone": "11999999999", "phone2": "11888888888", "city": "São Paulo" }, "product": { "brand": "Toyota", "model": "Corolla", "year": "2024", "color": "Branco", "km": "0", "price": "150000", "description": "...", "prop_ref": "REF123" }, "type_negotiation": 0, "body": "Mensagem opcional a anexar ao lead" } } } } } } }, "/sales_stand/attendance_summaries": { "get": { "operationId": "resumo_de_presen_as_get", "summary": "Resumo de Presenças", "description": "Lista o resumo de presenças por diretor/gerente/empresa com paginação de 50 registros por página.", "tags": [ "Stand de Vendas" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação gerado no C2S", "schema": { "type": "string" }, "example": "Bearer " }, { "name": "start_date", "required": true, "description": "Início do período.", "schema": { "type": "string", "example": "2024-01-01" }, "in": "query" }, { "name": "end_date", "required": true, "description": "Fim do período.", "schema": { "type": "string", "example": "2024-12-31" }, "in": "query" }, { "name": "sales_stand_ids[]", "required": false, "description": "Filtra por estande(s). Usar os id retornados por /stands.", "schema": { "type": "array", "items": { "type": "string" }, "example": "sales_stand_ids[]=abc123" }, "in": "query" }, { "name": "company_ids[]", "required": false, "description": "Filtra por empresas específicas da hierarquia.", "schema": { "type": "array", "items": { "type": "string" }, "example": "company_ids[]=abc123" }, "in": "query" }, { "name": "page", "required": false, "description": "Página desejada. Padrão: 1.", "schema": { "type": "integer", "example": 1 }, "in": "query" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "data": [ { "seller_id": "", "seller_name": "Nome do Vendedor", "total_attendances": 15, "total_leads_received": 10, "check_in_count": 20, "check_out_count": 20, "average_attendance_time_minutes": 45 } ] } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } } }, "/distribution_queues/:id/sellers_priorities": { "post": { "operationId": "atualizar_prioridades_dos_vendedores_post", "summary": "Atualizar Prioridades dos Vendedores", "description": "Atualiza as prioridades dos vendedores dentro de uma fila de distribuição.", "tags": [ "Filas de Distribuição" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "distribution_queue_sellers": [ { "id": 67890, "seller_id": 11111, "seller_name": "Maria Vendedora", "priority": 1, "status": "enabled" }, { "id": 67891, "seller_id": 22222, "seller_name": "Carlos Corretor", "priority": 2, "status": "enabled" } ] } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" } }, "required": [ "id" ] }, "example": { "...": "Configuração de prioridades dos vendedores" } } } } } }, "/sellers/:id": { "put": { "operationId": "atualizar_vendedor_put", "summary": "Atualizar Vendedor", "description": "Atualiza um vendedor existente. O :id é o ID criptografado do vendedor. Aceita os mesmos campos do POST além de recipient_rotation, recipient_distribution, recipient_memory e can_view_bucket.", "tags": [ "Usuários" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "id": "s1e2l3l4e5r6i7d8e9x0e1m2p3l4o5f6", "name": "Maria Vendedora Atualizada", "email": "maria.nova@empresa.com", "phone": "5511988888888", "company": "Empresa Exemplo", "company_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "is_recipient": 1, "can_view_bucket": true, "external_id": "", "external_name": "", "is_master": true } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "example": { "name": "Vendedor Atualizado", "email": "vendedor.novo@empresa.com", "is_recipient": true, "can_view_bucket": true } } } } } }, "/distribution_queues/:id/redistribute_lead": { "post": { "operationId": "redistribuir_lead_post", "summary": "Redistribuir Lead", "description": "Redistribui um lead pela fila de distribuição.", "tags": [ "Filas de Distribuição" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "lead_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "new_seller": { "id": 22222, "name": "Carlos Corretor", "company_name": "Empresa Exemplo" } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" } }, "required": [ "id" ] }, "example": { "id": "" } } } } } }, "/sellers/batch_update_timeshift": { "put": { "operationId": "batch_update_timeshift_put", "summary": "Batch Update Timeshift", "description": "Atualiza em lote a configuração de timeshift de múltiplos vendedores. Os vendedores são processados em ordem reversa e o last_lead_received_at é escalonado em 1 segundo para estabelecer ordem de prioridade.", "tags": [ "Usuários" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "seller_ids": [ "", "" ], "recipient_rotation": "...", "recipient_distribution": "...", "recipient_memory": "..." } } } } } }, "/leads/:id/forward": { "patch": { "operationId": "encaminhar_lead_patch", "summary": "Encaminhar Lead", "description": "Encaminha um lead para outro vendedor.", "tags": [ "Leads" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "lead": { "seller_id": 22222, "company_id": 2776, "id": 12345678, "lead_source_id": 349, "channel_id": 1, "read_at": "2026-04-16T12:53:23.000-03:00", "is_favorite": false, "status": 1, "description": "Apartamento 3 quartos", "created_at": "2026-04-16T12:52:52.000-03:00", "updated_at": "2026-04-16T12:53:30.000-03:00", "activity_date": "2026-04-20T11:00:00.000-03:00", "replied_at": null, "num_unread_msg_to_seller": 0 } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "example": { "seller_from_id": "", "seller_to_id": "" } } } } } }, "/distribution_queues/:id/next_seller": { "post": { "operationId": "definir_pr_ximo_vendedor_post", "summary": "Definir Próximo Vendedor", "description": "Define o próximo vendedor na rotação da fila de distribuição. O vendedor deve estar habilitado na fila.", "tags": [ "Filas de Distribuição" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "next_seller": { "id": 67890, "distribution_queue_id": 12345, "seller_id": 11111, "priority": 1, "last_lead_received_at": null, "status": "enabled", "created_at": "2026-04-15T15:03:40.000-03:00", "updated_at": "2026-04-15T15:03:40.000-03:00", "lead_skipped_at": null } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" } }, "required": [ "id" ] }, "example": { "next_queue_seller_id": 123 } } } } } }, "/leads/:id/tags": { "get": { "operationId": "listar_tags_do_lead_get", "summary": "Listar Tags do Lead", "description": "Retorna todas as tags de um lead.", "tags": [ "Leads" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "id", "required": true, "description": "ID criptografado do lead", "schema": { "type": "string" }, "in": "query" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "tags": [ { "id": "t1a2g3i4d5e6x7e8m9p0l1o2f3o4r5m6", "name": "Quente" }, { "id": "t2a3g4i5d6e7x8e9m0p1l2o3f4o5r6m7", "name": "Investidor" } ] } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } } } }, "/leads/:id/create_tag": { "post": { "operationId": "adicionar_tag_ao_lead_post", "summary": "Adicionar Tag ao Lead", "description": "Adiciona uma tag a um lead.", "tags": [ "Leads" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "tags": [ { "id": 5646064, "lead_id": 12345678, "created_at": "2026-04-16T12:53:13.000-03:00", "updated_at": "2026-04-16T12:53:13.000-03:00", "tag_id": 48437, "created_by_seller_id": null } ] } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "example": { "tag_id": "" } } } } } }, "/leads/:id/remove_tag": { "post": { "operationId": "remover_tag_do_lead_post", "summary": "Remover Tag do Lead", "description": "Remove uma ou mais tags de um lead. Aceita tag_id como string (única) ou array (múltiplas).", "tags": [ "Leads" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "tags": [] } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "example": { "tag_id": "" } } } } } }, "/leads/:id/mark_as_interacted": { "post": { "operationId": "marcar_lead_como_lido_post", "summary": "Marcar Lead como Lido", "description": "Marca um lead como lido/interagido.", "tags": [ "Leads" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "lead": { "num_unread_msg_to_seller": 0, "read_at": "2026-04-16T12:53:23.000-03:00", "id": 12345678, "status": 0, "created_at": "2026-04-16T12:52:52.000-03:00", "updated_at": "2026-04-16T12:53:23.000-03:00" } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "example": null } } } } }, "/leads/:id/create_message": { "post": { "operationId": "criar_mensagem_no_lead_post", "summary": "Criar Mensagem no Lead", "description": "Cria uma mensagem em um lead.", "tags": [ "Leads" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "201": { "description": "Resposta esperada", "content": { "application/json": { "example": { "data": { "type": "lead", "id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "internal_id": 12345678, "attributes": { "description": "Apartamento 3 quartos", "lead_status": { "id": 0, "alias": "new", "name": "Novo" }, "messages": [], "created_at": "2026-04-16T12:52:52.000-03:00", "updated_at": "2026-04-16T12:53:25.000-03:00" }, "messages": [ { "id": "m1e2s3s4a5g6e7i8d9e0x1e2m3p4l5o6", "sender_id": "s1e2n3d4e5r6i7d8e9x0e1m2p3l4o5f6", "recipient_id": "r1e2c3i4p5i6e7n8t9i0d1e2x3e4m5p6", "sender_type": "SysUser", "recipient_type": "Customer", "body": "Mensagem enviada via API", "created_at": "2026-04-16T12:53:25.000-03:00", "updated_at": "2026-04-16T12:53:25.000-03:00", "read_at": null } ] } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "example": { "body": "Texto da mensagem", "from": "bot", "url": "https://...", "external_id": "msg-ext-123", "created_at": "2025-01-15T10:00:00Z", "origin": "whatsapp", "message_type": "text", "sender_name": "João", "parent_message_id": "msg-parent-456", "tags": [ "", "" ] } } } } } }, "/leads/:id/create_activity": { "post": { "operationId": "criar_atividade_no_lead_post", "summary": "Criar Atividade no Lead", "description": "Cria uma atividade em um lead.", "tags": [ "Leads" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "201": { "description": "Resposta esperada", "content": { "application/json": { "example": { "data": { "type": "lead", "id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "internal_id": 12345678, "attributes": { "description": "Apartamento 3 quartos", "lead_status": { "id": 1, "alias": "under_negotiation", "name": "Em negociação" }, "log": [ { "body": "Atividade criada | Retornar para o cliente | 20 de Abril, 14:00 de 2026 | Agendar visita ao imóvel", "created_at": "2026-04-16T12:53:28.101-03:00" } ], "created_at": "2026-04-16T12:52:52.000-03:00", "updated_at": "2026-04-16T12:53:28.000-03:00", "last_activity_date": "2026-04-20T14:00:00.000-03:00" }, "schedulated_actions": [ { "id": "a1c2t3i4o5n6i7d8e9x0e1m2p3l4o5f6", "seller_id": "s1e2l3l4e5r6i7d8e9x0e1m2p3l4o5f6", "seller_name": "Maria Vendedora", "schedulated_action_type_id": 3, "schedulated_action_type_alias": "feedback_customer", "schedulated_action_name": "Retornar para o cliente", "schedulated_action_date": "2026-04-20T14:00:00.000-03:00", "description": "Agendar visita ao imóvel", "created_at": "2026-04-16T12:53:27.000-03:00", "status": "Em aberto" } ] } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "example": { "date": "2025-01-20T14:00:00Z", "type": { "activity": true }, "body": "Descrição da atividade", "send_push": true, "title": "Título da notificação" } } } } } }, "/leads/:id/update_status": { "post": { "operationId": "atualizar_status_do_lead_post", "summary": "Atualizar Status do Lead", "description": "Atualiza o status de um lead. Quando status = 3, o lead é marcado como perdido.", "tags": [ "Leads" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "201": { "description": "Resposta esperada", "content": { "application/json": { "example": { "data": { "type": "lead", "id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "internal_id": 12345678, "attributes": { "description": "Apartamento 3 quartos", "lead_status": { "id": 3, "alias": "lost", "name": "Arquivado" }, "archive_details": { "archived": true, "archive_notes": "Cliente não tem interesse" }, "lost_reasons": { "name": "inactive" }, "log": [ { "body": "O status foi alterado para Arquivado por Integração. | Detalhes: Cliente não tem interesse", "created_at": "2026-04-16T12:53:32.000-03:00" } ], "created_at": "2026-04-16T12:52:52.000-03:00", "updated_at": "2026-04-16T12:53:32.000-03:00" } } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "example": { "status": 3, "message": "Cliente não tem interesse", "lost_reason_ids": [ 12 ] } } } } } }, "/leads/:id/done_deal": { "post": { "operationId": "fechar_neg_cio_do_lead_post", "summary": "Fechar Negócio do Lead", "description": "Registra o fechamento de negócio de um lead.", "tags": [ "Leads" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Token de autenticação (preferencial)", "schema": { "type": "string" }, "example": "Bearer {token}" }, { "name": "Authentication", "in": "header", "required": true, "description": "Header alternativo para o mesmo token", "schema": { "type": "string" }, "example": "{token}" }, { "name": "Content-Type", "in": "header", "required": false, "description": "", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Resposta esperada", "content": { "application/json": { "example": { "success": true, "tags": { "id": 80123751, "done_deal_at": null, "lead_id": 12345678, "created_at": "2026-04-16T12:52:52.000-03:00", "updated_at": "2026-04-16T12:53:32.000-03:00", "done_details": null, "received_by_seller_id": 11111, "done_extra_vehicle": null, "done_extra_immobile": null, "done_price": null, "done_type_negotiation": null, "archieve_details": "Detalhes do arquivamento" } } } } }, "403": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "error": "not_authorized" } } } } }, "requestBody": { "description": "Body da requisição", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "example": { "prop_ref": "PROP-123", "done_type_negotiation": "sale", "info": "Detalhes do negócio", "date": "2025-01-15", "value": "500000" } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Token de autenticação gerado no C2S enviado no header Authorization." }, "tokenAuth": { "type": "apiKey", "in": "header", "name": "Authentication", "description": "Token de autenticação enviado diretamente no header Authentication (alternativo)." } } }, "security": [ { "bearerAuth": [] }, { "tokenAuth": [] } ] }