> For the complete documentation index, see [llms.txt](https://outboundpro.gitbook.io/api-v1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://outboundpro.gitbook.io/api-v1/contact/alternar-prospeccao.md). # Alternar prospecção ## Alternar status de prospecção > Marca/desmarca o contato como \*\*prospectado\*\* — controla se ele entra no\ > funil de prospecção automaticamente.\ > \ > Idempotente — passe \`prospected: true\` ou \`false\` direto (não é um toggle\ > cego, apesar do nome).\ > \ > \### Quando usar\ > \- \*\*Pausar prospecção sem deletar\*\* — contato é válido mas não é hora certa\ > de atacar. Marca como \`prospected: false\`.\ > \- \*\*Reativar contato dormente\*\* — depois de campanha que falhou, marca como\ > \`prospected: true\` pra entrar nas próximas listas.\ > \- \*\*Filtro no CRM externo\*\* — equipe comercial usa esse flag pra decidir\ > quem aparece no discador/sequenciador automático.\ > \ > \### Quando NÃO usar\ > \- \*\*Pra remover de vez\*\* — use \`/contact/delete\`. Toggle só pausa.\ > \- \*\*Pra mudar de lead\*\* — esse endpoint é por contato, não move entre leads.\ > \ > \### Casos de uso reais\ > \- \*\*Bot conversacional\*\*: prospect respondeu "não estou interessado neste\ > momento" → toggle-save false → bot do CRM pausa a sequência automática.\ > \- \*\*Workflow de "férias"\*\*: contato disse no e-mail "estou de férias até X",\ > toggle false → cron noturno reativa quando data X chegar.\ > \- \*\*Pipeline com gates\*\*: scoring baixou após 3 e-mails sem resposta →\ > marca prospected=false → contato sai do discador automaticamente.
```json {"openapi":"3.0.3","info":{"title":"OutboundPro API","version":"2.0.0"},"tags":[{"name":"Contact","description":"**Sócios e contatos de empresas** (`emp_socio` no banco interno).\nOperações completas: listar, criar, editar, marcar como principal,\ninferir e verificar e-mails, verificar WhatsApp, buscar dados privados\n(com créditos), e listar outras empresas onde o contato é sócio.\n\n### Conceitos chave\n- **Contato principal** (`is_primary_contact`): cada empresa tem 1 contato\n marcado como principal. `set-primary` automaticamente despromove o anterior.\n- **Prospectado** (`is_prospected`): flag de \"este contato vai entrar no\n funil de prospecção\". Marcar/desmarcar via `toggle-save`.\n- **Inferência de e-mail**: gera candidato a e-mail baseado em nome do contato\n + domínio do website da empresa (ex.: `joao.silva@empresa.com.br`),\n com score de confiança. **Não envia teste** — apenas predição.\n- **Verificação de e-mail**: probe DNS + SMTP nos e-mails cadastrados, retorna\n `status` (1=pending, 2=valid, 3=invalid).\n- **Verificação de WhatsApp**: testa cada número, retorna `whatsapp: true/false`\n + `whatsapp_name` e `whatsapp_photo` se disponível.\n- **Dados privados** (`find-private-data`): **consome créditos pagos**, busca\n telefones/emails em serviços externos (Unitfour Intouch, etc.). Verifique\n saldo antes.\n\n### Performance\nEndpoint `contact/list` sem filtro varre toda a tabela `empresa_socio` —\nuse `lead_id` ou `lead_hash` para escopo restrito (recomendado).\n"}],"servers":[{"url":"https://app.outboundpro.com.br/api","description":"Produção"}],"security":[{"TokenAuth":[]}],"components":{"securitySchemes":{"TokenAuth":{"type":"apiKey","in":"header","name":"Token","description":"Chave privada do cliente (`cli_chave_privada`). Formato UUID v4\n(36 caracteres com hífens). Aceita header em qualquer case\n(`Token`, `token`, `TOKEN`).\n"}},"schemas":{"Contact":{"type":"object","properties":{"id":{"type":"integer","description":"ID interno do contato (`emso_codigo`)."},"name":{"type":"string"},"document":{"type":"string","description":"CPF do contato (mascarado parcialmente em sócios da Receita)."},"qualification":{"type":"string","description":"Qualificação (ex.: Sócio-Administrador, Diretor, Procurador)."},"age_range":{"type":"string"},"partnership_entry_date":{"type":"string","format":"date","description":"Data de entrada na sociedade (para sócios)."},"linkedin":{"type":"string","format":"uri"},"facebook":{"type":"string","format":"uri"},"instagram":{"type":"string","format":"uri"},"is_primary_contact":{"type":"boolean","description":"Marcação de contato principal da empresa."},"is_prospected":{"type":"boolean","description":"Marcação de \"vai entrar no funil de prospecção\"."},"is_manual_registration":{"type":"boolean","description":"Se o contato foi cadastrado manualmente (não veio da Receita).\nÚtil para distinguir dados oficiais de complementares.\n"},"custom_fields":{"type":"object","description":"Campos personalizados configurados pelo cliente (livre).","additionalProperties":true},"phones":{"type":"array","items":{"$ref":"#/components/schemas/Phone"}},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"}},"inferred_email":{"type":"object","nullable":true,"description":"Resultado da última inferência de e-mail (se houver).","properties":{"full_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"inferred_email":{"type":"string","format":"email"},"score":{"type":"integer","minimum":0,"maximum":100,"description":"Confiança da inferência (0-100)."},"site":{"type":"string","description":"Domínio usado na composição (do website da empresa)."},"domain_catch_all":{"type":"boolean","description":"Se o domínio aceita catch-all (toda inferência válida — útil saber para evitar bounces)."},"linkedin":{"type":"string","nullable":true},"twitter":{"type":"string","nullable":true}}},"company":{"type":"object","description":"Sub-objeto resumido da empresa do contato.","properties":{"id":{"type":"integer"},"hash":{"type":"string"},"cnpj":{"type":"string"},"company_name":{"type":"string"},"trade_name":{"type":"string"}}}}},"Phone":{"type":"object","properties":{"id":{"type":"integer","description":"ID interno do telefone (`est_codigo`)."},"number":{"type":"string","description":"Número sem máscara, com DDD."},"type":{"type":"string","enum":["CELULAR","FIXO"]},"whatsapp":{"type":"boolean","description":"Se o número está conectado ao WhatsApp (resultado da última verificação)."},"valid":{"type":"boolean","description":"Se foi validado por algum probe (DNS/portabilidade)."},"priority":{"type":"integer","description":"Ordem de exibição (1 = principal)."},"source":{"type":"string","description":"Origem do dado (`receita`, `manual`, `intouch`, etc.)."}}},"Email":{"type":"object","properties":{"id":{"type":"integer"},"email":{"type":"string","format":"email"},"valid":{"type":"boolean"},"priority":{"type":"integer"},"source":{"type":"string"}}},"ErrorResponse":{"type":"object","required":["response"],"properties":{"response":{"type":"string","enum":["error"]},"mensagem":{"type":"string","description":"Descrição do erro em pt-BR. Família Contact usa `message` (legado)."},"message":{"type":"string","description":"Equivalente inglês de `mensagem`, usado pela família Contact."}}}},"responses":{"Unauthorized":{"description":"Token ausente, inválido ou cliente inativo.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Recurso não encontrado. Pode ser por:\n- ID inexistente.\n- ID existe **em outro cliente** (isolamento de tenant retorna 404, não 403).\n- Recurso foi deletado/soft-deleted.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/contact/toggle-save":{"post":{"tags":["Contact"],"summary":"Alternar status de prospecção","operationId":"contactToggleSave","description":"Marca/desmarca o contato como **prospectado** — controla se ele entra no\nfunil de prospecção automaticamente.\n\nIdempotente — passe `prospected: true` ou `false` direto (não é um toggle\ncego, apesar do nome).\n\n### Quando usar\n- **Pausar prospecção sem deletar** — contato é válido mas não é hora certa\n de atacar. Marca como `prospected: false`.\n- **Reativar contato dormente** — depois de campanha que falhou, marca como\n `prospected: true` pra entrar nas próximas listas.\n- **Filtro no CRM externo** — equipe comercial usa esse flag pra decidir\n quem aparece no discador/sequenciador automático.\n\n### Quando NÃO usar\n- **Pra remover de vez** — use `/contact/delete`. Toggle só pausa.\n- **Pra mudar de lead** — esse endpoint é por contato, não move entre leads.\n\n### Casos de uso reais\n- **Bot conversacional**: prospect respondeu \"não estou interessado neste\n momento\" → toggle-save false → bot do CRM pausa a sequência automática.\n- **Workflow de \"férias\"**: contato disse no e-mail \"estou de férias até X\",\n toggle false → cron noturno reativa quando data X chegar.\n- **Pipeline com gates**: scoring baixou após 3 e-mails sem resposta →\n marca prospected=false → contato sai do discador automaticamente.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","prospected"],"properties":{"id":{"type":"integer"},"prospected":{"type":"boolean","description":"Estado final desejado (não inverte)."}}}}}},"responses":{"200":{"description":"Estado atualizado.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"string","enum":["success"]},"message":{"type":"string"},"contact":{"$ref":"#/components/schemas/Contact"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}}} ```