{"openapi":"3.0.0","paths":{"/v1/me":{"get":{"description":"Retorna a conta dona da chave, as permissões da chave e os limites de uso. Útil para testar a chave.","operationId":"getAccount","parameters":[],"responses":{"200":{"headers":{"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"description":"Conta da chave.","content":{"application/json":{"schema":{"type":"object","required":["account_name","scopes","limits"],"properties":{"account_name":{"type":"string","nullable":true,"example":"Exemplo Ltda","description":"Nome da conta dona da chave."},"scopes":{"type":"array","items":{"type":"string"},"example":["data:read"],"description":"Permissões da chave. Hoje: `data:read`."},"limits":{"type":"object","description":"Limites de uso da conta.","required":["per_minute","per_day"],"properties":{"per_minute":{"type":"integer","example":60,"description":"Requisições por minuto, por chave."},"per_day":{"type":"integer","example":10000,"description":"Requisições por dia, somando todas as chaves."}}}}}}}},"401":{"description":"Chave ausente, inválida ou revogada.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"403":{"description":"API de dados desligada na conta, ou plano sem acesso.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"429":{"description":"Limite de requisições atingido (por minuto, por dia ou simultâneas). Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"500":{"description":"Erro inesperado. Repita com espera crescente.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"503":{"description":"Serviço temporariamente indisponível. Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}}},"security":[{"bearer":[]}],"summary":"Obter conta","tags":["Conta"]}},"/v1/contacts":{"get":{"description":"Lista os contatos da conta com a etapa atual e a primeira origem (anúncio ou link). Contatos do ambiente de teste não aparecem.","operationId":"listContacts","parameters":[{"name":"updated_since","required":false,"in":"query","schema":{"type":"string"},"description":"Retorna só registros criados ou alterados a partir deste instante: data e hora ISO 8601 com fuso, ou só a data (`AAAA-MM-DD`, meia-noite UTC). A busca recua 5 minutos para cobrir diferenças de relógio, então grave pela chave primária (`id`)."},{"name":"cursor","required":false,"in":"query","schema":{"type":"string"},"description":"Valor de `next_cursor` da página anterior."},{"name":"limit","required":false,"in":"query","schema":{"type":"integer","minimum":1,"maximum":200,"default":100},"description":"Itens por página."}],"responses":{"200":{"headers":{"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"description":"Página de contatos.","content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor","has_more","sync_watermark"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","created_at","updated_at","name","first_name","last_name","email","phone","job_title","company_name","icp_id","qualification_score","temperature","source","source_detail","consent_given_at","do_not_contact","do_not_contact_at","won_at","lost_at","current_stage_id","current_stage_entered_at","current_agent_id","last_activity_at","first_origin_kind","first_origin_ad_id","first_origin_ctwa_clid","first_origin_headline","first_origin_at","first_campaign_id"],"properties":{"id":{"type":"string","nullable":false,"description":"Identificador único do registro.","example":"3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10"},"created_at":{"type":"string","format":"date-time","nullable":false,"description":"Data de criação.","example":"2026-10-13T14:02:11.000Z"},"updated_at":{"type":"string","format":"date-time","nullable":false,"description":"Data da última alteração.","example":"2026-10-13T14:31:02.000Z"},"name":{"type":"string","nullable":true,"description":"Nome completo.","example":"Maria Souza"},"first_name":{"type":"string","nullable":true,"description":"Primeiro nome.","example":"Maria"},"last_name":{"type":"string","nullable":true,"description":"Sobrenome.","example":"Souza"},"email":{"type":"string","nullable":true,"description":"E-mail.","example":"maria@exemplo.com.br"},"phone":{"type":"string","nullable":true,"description":"Telefone no formato E.164, por exemplo `+5548999990000`.","example":"+5548999990000"},"job_title":{"type":"string","nullable":true,"description":"Cargo.","example":"Gerente comercial"},"company_name":{"type":"string","nullable":true,"description":"Empresa.","example":"Exemplo Ltda"},"icp_id":{"type":"string","nullable":true,"description":"Perfil de cliente ideal em que o contato foi enquadrado.","example":"c4d8e2f1-3a6b-4c9d-8e7f-1a2b3c4d5e6f"},"qualification_score":{"type":"integer","nullable":true,"description":"Pontuação de qualificação calculada pelas regras do perfil.","example":72},"temperature":{"type":"string","nullable":true,"description":"Propensão de compra estimada. Valores: `hot`, `warm` ou `cold`.","example":"warm"},"source":{"type":"string","nullable":true,"description":"Como o contato entrou. Valores: `manual`, `inbound_whatsapp`, `webhook_form`, `api` ou `hubspot`.","example":"inbound_whatsapp"},"source_detail":{"type":"string","nullable":true,"description":"Complemento da origem, como o material, a página ou a campanha.","example":"Campanha de outubro"},"consent_given_at":{"type":"string","format":"date-time","nullable":true,"description":"Data em que o contato deu consentimento.","example":"2026-10-13T14:02:11.000Z"},"do_not_contact":{"type":"boolean","description":"`true` quando o contato pediu para não receber mensagens.","example":false},"do_not_contact_at":{"type":"string","format":"date-time","nullable":true,"description":"Data do pedido para não receber mensagens.","example":null},"won_at":{"type":"string","format":"date-time","nullable":true,"description":"Data em que o contato chegou a uma etapa de ganho.","example":null},"lost_at":{"type":"string","format":"date-time","nullable":true,"description":"Data em que o contato chegou a uma etapa de perda.","example":null},"current_stage_id":{"type":"string","nullable":true,"description":"Etapa atual do contato. Detalhes em `/v1/pipeline_stages`.","example":"9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d"},"current_stage_entered_at":{"type":"string","format":"date-time","nullable":true,"description":"Data de entrada na etapa atual.","example":"2026-10-13T14:02:11.000Z"},"current_agent_id":{"type":"string","nullable":true,"description":"Agente responsável pelo contato hoje.","example":"b7e1c0d2-5a4f-4e3b-8c9d-2f1a0e6d3c55"},"last_activity_at":{"type":"string","format":"date-time","nullable":true,"description":"Data da última mensagem trocada com o contato, em qualquer conversa.","example":"2026-10-13T14:30:48.000Z"},"first_origin_kind":{"type":"string","nullable":true,"description":"Origem da primeira conversa com origem conhecida. Valores: `ad` (anúncio Click-to-WhatsApp da Meta) ou `link` (texto de um link de campanha).","example":"ad"},"first_origin_ad_id":{"type":"string","nullable":true,"description":"Identificador do anúncio na Meta, na primeira origem.","example":"120211234567890123"},"first_origin_ctwa_clid":{"type":"string","nullable":true,"description":"Identificador de clique da Meta (`ctwa_clid`), na primeira origem.","example":"ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO"},"first_origin_headline":{"type":"string","nullable":true,"description":"Título do anúncio, na primeira origem.","example":"Fale com um especialista"},"first_origin_at":{"type":"string","format":"date-time","nullable":true,"description":"Data em que a primeira origem foi registrada.","example":"2026-10-13T14:02:11.000Z"},"first_campaign_id":{"type":"string","nullable":true,"description":"Campanha cadastrada na Ziala que corresponde à primeira origem.","example":"d5e6f7a8-9b0c-4d1e-8f2a-3b4c5d6e7f80"}}}},"next_cursor":{"type":"string","nullable":true,"example":"eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9","description":"Cursor da próxima página, para enviar em `cursor`. `null` na última página."},"has_more":{"type":"boolean","example":true,"description":"`true` se há mais páginas."},"sync_watermark":{"type":"string","format":"date-time","example":"2026-10-13T14:29:00.000Z","description":"Instante até o qual esta leitura está completa, igual em todas as páginas. Envie como `updated_since` na próxima sincronização."}}}}}},"400":{"description":"Parâmetro inválido, ou cursor alterado ou de outra conta.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"401":{"description":"Chave ausente, inválida ou revogada.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"403":{"description":"API de dados desligada na conta, ou plano sem acesso.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"429":{"description":"Limite de requisições atingido (por minuto, por dia ou simultâneas). Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"500":{"description":"Erro inesperado. Repita com espera crescente.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"503":{"description":"Serviço temporariamente indisponível. Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}}},"security":[{"bearer":[]}],"summary":"Listar contatos","tags":["Contatos"]}},"/v1/contacts/{id}":{"get":{"description":"Retorna um contato pelo `id`.","operationId":"getContact","parameters":[{"name":"id","required":true,"in":"path","description":"Identificador do contato.","schema":{"type":"string"}}],"responses":{"200":{"headers":{"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"description":"O contato.","content":{"application/json":{"schema":{"type":"object","required":["id","created_at","updated_at","name","first_name","last_name","email","phone","job_title","company_name","icp_id","qualification_score","temperature","source","source_detail","consent_given_at","do_not_contact","do_not_contact_at","won_at","lost_at","current_stage_id","current_stage_entered_at","current_agent_id","last_activity_at","first_origin_kind","first_origin_ad_id","first_origin_ctwa_clid","first_origin_headline","first_origin_at","first_campaign_id"],"properties":{"id":{"type":"string","nullable":false,"description":"Identificador único do registro.","example":"3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10"},"created_at":{"type":"string","format":"date-time","nullable":false,"description":"Data de criação.","example":"2026-10-13T14:02:11.000Z"},"updated_at":{"type":"string","format":"date-time","nullable":false,"description":"Data da última alteração.","example":"2026-10-13T14:31:02.000Z"},"name":{"type":"string","nullable":true,"description":"Nome completo.","example":"Maria Souza"},"first_name":{"type":"string","nullable":true,"description":"Primeiro nome.","example":"Maria"},"last_name":{"type":"string","nullable":true,"description":"Sobrenome.","example":"Souza"},"email":{"type":"string","nullable":true,"description":"E-mail.","example":"maria@exemplo.com.br"},"phone":{"type":"string","nullable":true,"description":"Telefone no formato E.164, por exemplo `+5548999990000`.","example":"+5548999990000"},"job_title":{"type":"string","nullable":true,"description":"Cargo.","example":"Gerente comercial"},"company_name":{"type":"string","nullable":true,"description":"Empresa.","example":"Exemplo Ltda"},"icp_id":{"type":"string","nullable":true,"description":"Perfil de cliente ideal em que o contato foi enquadrado.","example":"c4d8e2f1-3a6b-4c9d-8e7f-1a2b3c4d5e6f"},"qualification_score":{"type":"integer","nullable":true,"description":"Pontuação de qualificação calculada pelas regras do perfil.","example":72},"temperature":{"type":"string","nullable":true,"description":"Propensão de compra estimada. Valores: `hot`, `warm` ou `cold`.","example":"warm"},"source":{"type":"string","nullable":true,"description":"Como o contato entrou. Valores: `manual`, `inbound_whatsapp`, `webhook_form`, `api` ou `hubspot`.","example":"inbound_whatsapp"},"source_detail":{"type":"string","nullable":true,"description":"Complemento da origem, como o material, a página ou a campanha.","example":"Campanha de outubro"},"consent_given_at":{"type":"string","format":"date-time","nullable":true,"description":"Data em que o contato deu consentimento.","example":"2026-10-13T14:02:11.000Z"},"do_not_contact":{"type":"boolean","description":"`true` quando o contato pediu para não receber mensagens.","example":false},"do_not_contact_at":{"type":"string","format":"date-time","nullable":true,"description":"Data do pedido para não receber mensagens.","example":null},"won_at":{"type":"string","format":"date-time","nullable":true,"description":"Data em que o contato chegou a uma etapa de ganho.","example":null},"lost_at":{"type":"string","format":"date-time","nullable":true,"description":"Data em que o contato chegou a uma etapa de perda.","example":null},"current_stage_id":{"type":"string","nullable":true,"description":"Etapa atual do contato. Detalhes em `/v1/pipeline_stages`.","example":"9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d"},"current_stage_entered_at":{"type":"string","format":"date-time","nullable":true,"description":"Data de entrada na etapa atual.","example":"2026-10-13T14:02:11.000Z"},"current_agent_id":{"type":"string","nullable":true,"description":"Agente responsável pelo contato hoje.","example":"b7e1c0d2-5a4f-4e3b-8c9d-2f1a0e6d3c55"},"last_activity_at":{"type":"string","format":"date-time","nullable":true,"description":"Data da última mensagem trocada com o contato, em qualquer conversa.","example":"2026-10-13T14:30:48.000Z"},"first_origin_kind":{"type":"string","nullable":true,"description":"Origem da primeira conversa com origem conhecida. Valores: `ad` (anúncio Click-to-WhatsApp da Meta) ou `link` (texto de um link de campanha).","example":"ad"},"first_origin_ad_id":{"type":"string","nullable":true,"description":"Identificador do anúncio na Meta, na primeira origem.","example":"120211234567890123"},"first_origin_ctwa_clid":{"type":"string","nullable":true,"description":"Identificador de clique da Meta (`ctwa_clid`), na primeira origem.","example":"ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO"},"first_origin_headline":{"type":"string","nullable":true,"description":"Título do anúncio, na primeira origem.","example":"Fale com um especialista"},"first_origin_at":{"type":"string","format":"date-time","nullable":true,"description":"Data em que a primeira origem foi registrada.","example":"2026-10-13T14:02:11.000Z"},"first_campaign_id":{"type":"string","nullable":true,"description":"Campanha cadastrada na Ziala que corresponde à primeira origem.","example":"d5e6f7a8-9b0c-4d1e-8f2a-3b4c5d6e7f80"}}}}}},"401":{"description":"Chave ausente, inválida ou revogada.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"403":{"description":"API de dados desligada na conta, ou plano sem acesso.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"404":{"description":"Registro não encontrado nesta conta.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"429":{"description":"Limite de requisições atingido (por minuto, por dia ou simultâneas). Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"500":{"description":"Erro inesperado. Repita com espera crescente.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"503":{"description":"Serviço temporariamente indisponível. Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}}},"security":[{"bearer":[]}],"summary":"Obter contato","tags":["Contatos"]}},"/v1/contact_fields":{"get":{"description":"Lista os valores dos campos personalizados dos contatos em formato longo: uma linha por contato e campo. As definições dos campos estão em `/v1/fields`.","operationId":"listContactFields","parameters":[{"name":"updated_since","required":false,"in":"query","schema":{"type":"string"},"description":"Retorna só registros criados ou alterados a partir deste instante: data e hora ISO 8601 com fuso, ou só a data (`AAAA-MM-DD`, meia-noite UTC). A busca recua 5 minutos para cobrir diferenças de relógio, então grave pela chave primária (`contact_id` + `field_key`)."},{"name":"cursor","required":false,"in":"query","schema":{"type":"string"},"description":"Valor de `next_cursor` da página anterior."},{"name":"limit","required":false,"in":"query","schema":{"type":"integer","minimum":1,"maximum":200,"default":100},"description":"Itens por página."}],"responses":{"200":{"headers":{"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"description":"Página de valores.","content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor","has_more","sync_watermark"],"properties":{"data":{"type":"array","items":{"type":"object","required":["contact_id","field_key","value","updated_at"],"properties":{"contact_id":{"type":"string","nullable":false,"description":"Identificador do contato.","example":"3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10"},"field_key":{"type":"string","nullable":false,"description":"Chave do campo. Definições em `/v1/fields`.","example":"segmento"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"nullable":true,"description":"Valor do campo: texto, número ou booleano. Listas e objetos vêm serializados como texto JSON.","example":"Varejo"},"updated_at":{"type":"string","format":"date-time","nullable":false,"description":"Data da última alteração.","example":"2026-10-13T14:31:02.000Z"}}}},"next_cursor":{"type":"string","nullable":true,"example":"eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9","description":"Cursor da próxima página, para enviar em `cursor`. `null` na última página."},"has_more":{"type":"boolean","example":true,"description":"`true` se há mais páginas."},"sync_watermark":{"type":"string","format":"date-time","example":"2026-10-13T14:29:00.000Z","description":"Instante até o qual esta leitura está completa, igual em todas as páginas. Envie como `updated_since` na próxima sincronização."}}}}}},"400":{"description":"Parâmetro inválido, ou cursor alterado ou de outra conta.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"401":{"description":"Chave ausente, inválida ou revogada.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"403":{"description":"API de dados desligada na conta, ou plano sem acesso.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"429":{"description":"Limite de requisições atingido (por minuto, por dia ou simultâneas). Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"500":{"description":"Erro inesperado. Repita com espera crescente.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"503":{"description":"Serviço temporariamente indisponível. Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}}},"security":[{"bearer":[]}],"summary":"Listar valores de campos","tags":["Contatos"]}},"/v1/conversations":{"get":{"description":"Lista as conversas com origem, resultado, contagem de mensagens e horário da primeira resposta. O conteúdo das mensagens não é exposto.","operationId":"listConversations","parameters":[{"name":"updated_since","required":false,"in":"query","schema":{"type":"string"},"description":"Retorna só registros criados ou alterados a partir deste instante: data e hora ISO 8601 com fuso, ou só a data (`AAAA-MM-DD`, meia-noite UTC). A busca recua 5 minutos para cobrir diferenças de relógio, então grave pela chave primária (`id`)."},{"name":"cursor","required":false,"in":"query","schema":{"type":"string"},"description":"Valor de `next_cursor` da página anterior."},{"name":"limit","required":false,"in":"query","schema":{"type":"integer","minimum":1,"maximum":200,"default":100},"description":"Itens por página."}],"responses":{"200":{"headers":{"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"description":"Página de conversas.","content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor","has_more","sync_watermark"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","contact_id","created_at","updated_at","closed_at","active","channel_id","agent_id","origin_kind","origin_ad_id","origin_ctwa_clid","origin_headline","origin_at","campaign_id","outcome_category","outcome_stage_id","outcome_set_at","contact_message_count","agent_message_count","first_response_at"],"properties":{"id":{"type":"string","nullable":false,"description":"Identificador único do registro.","example":"7c2d9e41-0a3b-4f5c-8d6e-1f2a3b4c5d6e"},"contact_id":{"type":"string","nullable":false,"description":"Identificador do contato.","example":"3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10"},"created_at":{"type":"string","format":"date-time","nullable":false,"description":"Início da conversa.","example":"2026-10-13T14:02:11.000Z"},"updated_at":{"type":"string","format":"date-time","nullable":false,"description":"Data da última alteração.","example":"2026-10-13T14:31:02.000Z"},"closed_at":{"type":"string","format":"date-time","nullable":true,"description":"Data de encerramento. `null` enquanto a conversa está ativa.","example":null},"active":{"type":"boolean","nullable":false,"description":"`true` enquanto a conversa está ativa.","example":true},"channel_id":{"type":"string","nullable":true,"description":"Número de WhatsApp que atendeu a conversa.","example":"f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4a5b"},"agent_id":{"type":"string","nullable":true,"description":"Agente que conduziu a conversa.","example":"b7e1c0d2-5a4f-4e3b-8c9d-2f1a0e6d3c55"},"origin_kind":{"type":"string","nullable":true,"description":"Origem da conversa. Valores: `ad` (anúncio Click-to-WhatsApp da Meta) ou `link` (texto de um link de campanha). Se a pessoa chegar por um segundo anúncio na mesma conversa, vale o mais recente.","example":"ad"},"origin_ad_id":{"type":"string","nullable":true,"description":"Identificador do anúncio na Meta.","example":"120211234567890123"},"origin_ctwa_clid":{"type":"string","nullable":true,"description":"Identificador de clique da Meta (`ctwa_clid`).","example":"ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO"},"origin_headline":{"type":"string","nullable":true,"description":"Título do anúncio.","example":"Fale com um especialista"},"origin_at":{"type":"string","format":"date-time","nullable":true,"description":"Data em que a origem foi registrada.","example":"2026-10-13T14:02:11.000Z"},"campaign_id":{"type":"string","nullable":true,"description":"Campanha cadastrada na Ziala que corresponde à origem.","example":"d5e6f7a8-9b0c-4d1e-8f2a-3b4c5d6e7f80"},"outcome_category":{"type":"string","nullable":true,"description":"Resultado da conversa. Valores: `qualified`, `disqualified` ou `open`. `null` enquanto ativa.","example":null},"outcome_stage_id":{"type":"string","nullable":true,"description":"Etapa em que o contato estava quando a conversa foi encerrada.","example":null},"outcome_set_at":{"type":"string","format":"date-time","nullable":true,"description":"Data em que o resultado foi registrado.","example":null},"contact_message_count":{"type":"integer","nullable":false,"description":"Mensagens enviadas pelo contato.","example":6},"agent_message_count":{"type":"integer","nullable":false,"description":"Mensagens enviadas pelo agente.","example":7},"first_response_at":{"type":"string","format":"date-time","nullable":true,"description":"Primeira resposta do agente depois da primeira mensagem do contato.","example":"2026-10-13T14:02:19.000Z"}}}},"next_cursor":{"type":"string","nullable":true,"example":"eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9","description":"Cursor da próxima página, para enviar em `cursor`. `null` na última página."},"has_more":{"type":"boolean","example":true,"description":"`true` se há mais páginas."},"sync_watermark":{"type":"string","format":"date-time","example":"2026-10-13T14:29:00.000Z","description":"Instante até o qual esta leitura está completa, igual em todas as páginas. Envie como `updated_since` na próxima sincronização."}}}}}},"400":{"description":"Parâmetro inválido, ou cursor alterado ou de outra conta.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"401":{"description":"Chave ausente, inválida ou revogada.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"403":{"description":"API de dados desligada na conta, ou plano sem acesso.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"429":{"description":"Limite de requisições atingido (por minuto, por dia ou simultâneas). Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"500":{"description":"Erro inesperado. Repita com espera crescente.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"503":{"description":"Serviço temporariamente indisponível. Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}}},"security":[{"bearer":[]}],"summary":"Listar conversas","tags":["Conversas"]}},"/v1/stage_events":{"get":{"description":"Lista o histórico de mudanças de etapa dos contatos. Os registros são imutáveis e filtrados pela data de criação.","operationId":"listStageEvents","parameters":[{"name":"updated_since","required":false,"in":"query","schema":{"type":"string"},"description":"Retorna só registros criados a partir deste instante: data e hora ISO 8601 com fuso, ou só a data (`AAAA-MM-DD`, meia-noite UTC). A busca recua 5 minutos para cobrir diferenças de relógio, então grave pela chave primária (`id`)."},{"name":"created_since","required":false,"in":"query","schema":{"type":"string"},"description":"Sinônimo de `updated_since`."},{"name":"cursor","required":false,"in":"query","schema":{"type":"string"},"description":"Valor de `next_cursor` da página anterior."},{"name":"limit","required":false,"in":"query","schema":{"type":"integer","minimum":1,"maximum":200,"default":100},"description":"Itens por página."}],"responses":{"200":{"headers":{"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"description":"Página de mudanças de etapa.","content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor","has_more","sync_watermark"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","contact_id","pipeline_id","agent_id","from_stage_id","from_stage_key","to_stage_id","to_stage_key","created_at"],"properties":{"id":{"type":"string","nullable":false,"description":"Identificador único do registro.","example":"5b8e3f20-6c1d-4a7e-9f0b-2c3d4e5f6a7b"},"contact_id":{"type":"string","nullable":false,"description":"Identificador do contato.","example":"3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10"},"pipeline_id":{"type":"string","nullable":true,"description":"Identificador do funil.","example":"e2a9f4c1-7b3d-4f6e-a1c8-9d0b5e2f7a33"},"agent_id":{"type":"string","nullable":true,"description":"Agente em atendimento no momento da mudança.","example":"b7e1c0d2-5a4f-4e3b-8c9d-2f1a0e6d3c55"},"from_stage_id":{"type":"string","nullable":true,"description":"Etapa de origem. `null` na entrada no funil.","example":"8b0a1c2d-3e4f-4a5b-9c6d-7e8f9a0b1c2d"},"from_stage_key":{"type":"string","nullable":true,"description":"Chave da etapa de origem.","example":"novo"},"to_stage_id":{"type":"string","nullable":true,"description":"Etapa de destino.","example":"9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d"},"to_stage_key":{"type":"string","nullable":true,"description":"Chave da etapa de destino.","example":"qualificando"},"created_at":{"type":"string","format":"date-time","nullable":false,"description":"Data de criação.","example":"2026-10-13T14:02:11.000Z"}}}},"next_cursor":{"type":"string","nullable":true,"example":"eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9","description":"Cursor da próxima página, para enviar em `cursor`. `null` na última página."},"has_more":{"type":"boolean","example":true,"description":"`true` se há mais páginas."},"sync_watermark":{"type":"string","format":"date-time","example":"2026-10-13T14:29:00.000Z","description":"Instante até o qual esta leitura está completa, igual em todas as páginas. Envie como `updated_since` na próxima sincronização."}}}}}},"400":{"description":"Parâmetro inválido, ou cursor alterado ou de outra conta.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"401":{"description":"Chave ausente, inválida ou revogada.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"403":{"description":"API de dados desligada na conta, ou plano sem acesso.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"429":{"description":"Limite de requisições atingido (por minuto, por dia ou simultâneas). Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"500":{"description":"Erro inesperado. Repita com espera crescente.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"503":{"description":"Serviço temporariamente indisponível. Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}}},"security":[{"bearer":[]}],"summary":"Listar mudanças de etapa","tags":["Funis"]}},"/v1/pipeline_stages":{"get":{"description":"Lista todas as etapas de todos os funis da conta, numa página só. `next_cursor`, `has_more` e `sync_watermark` existem só para manter o formato comum das listas.","operationId":"listPipelineStages","parameters":[],"responses":{"200":{"headers":{"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"description":"Todas as etapas.","content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor","has_more","sync_watermark"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","pipeline_id","pipeline_name","key","label","sort_order","is_won","is_lost","is_terminal"],"properties":{"id":{"type":"string","nullable":false,"description":"Identificador único do registro.","example":"3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10"},"pipeline_id":{"type":"string","nullable":false,"description":"Identificador do funil.","example":"e2a9f4c1-7b3d-4f6e-a1c8-9d0b5e2f7a33"},"pipeline_name":{"type":"string","nullable":false,"description":"Nome do funil.","example":"Vendas"},"key":{"type":"string","nullable":false,"description":"Chave estável, usada para referenciar o registro em outros objetos.","example":"qualificando"},"label":{"type":"string","nullable":false,"description":"Nome exibido no painel.","example":"Qualificando"},"sort_order":{"type":"integer","nullable":false,"description":"Posição da etapa no funil, em ordem crescente.","example":2},"is_won":{"type":"boolean","description":"`true` se a etapa conta como ganho.","example":false},"is_lost":{"type":"boolean","description":"`true` se a etapa conta como perda.","example":false},"is_terminal":{"type":"boolean","description":"`true` se a etapa encerra o funil.","example":false}}}},"next_cursor":{"type":"string","nullable":true,"example":"eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9","description":"Cursor da próxima página. Sempre `null`: o endpoint devolve tudo numa página."},"has_more":{"type":"boolean","example":false,"description":"`true` se há mais páginas. Sempre `false`: o endpoint devolve tudo numa página."},"sync_watermark":{"type":"string","format":"date-time","example":"2026-10-13T14:29:00.000Z","description":"Instante até o qual esta leitura está completa, igual em todas as páginas. Envie como `updated_since` na próxima sincronização."}}}}}},"401":{"description":"Chave ausente, inválida ou revogada.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"403":{"description":"API de dados desligada na conta, ou plano sem acesso.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"429":{"description":"Limite de requisições atingido (por minuto, por dia ou simultâneas). Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"500":{"description":"Erro inesperado. Repita com espera crescente.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"503":{"description":"Serviço temporariamente indisponível. Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}}},"security":[{"bearer":[]}],"summary":"Listar etapas","tags":["Funis"]}},"/v1/fields":{"get":{"description":"Lista as definições dos campos personalizados da conta, numa página só. `next_cursor`, `has_more` e `sync_watermark` existem só para manter o formato comum das listas.","operationId":"listFields","parameters":[],"responses":{"200":{"headers":{"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"description":"Todas as definições.","content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor","has_more","sync_watermark"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","object_type","key","label","type","options","group","archived_at","created_at","updated_at"],"properties":{"id":{"type":"string","nullable":false,"description":"Identificador da versão do campo. Quando o tipo muda, nasce uma versão nova com a mesma `key`, e a anterior fica com `archived_at` preenchido.","example":"6e4f2a1b-9c8d-4e7f-b0a1-2b3c4d5e6f70"},"object_type":{"type":"string","nullable":false,"description":"Objeto a que o campo pertence: `contact`, `conversation` ou `product`.","example":"contact"},"key":{"type":"string","nullable":false,"description":"Chave estável, usada para referenciar o registro em outros objetos.","example":"segmento"},"label":{"type":"string","nullable":false,"description":"Nome exibido no painel.","example":"Segmento"},"type":{"type":"string","nullable":false,"description":"Tipo do valor: `text`, `longtext`, `number`, `boolean`, `date`, `datetime`, `enum`, `multiselect`, `phone`, `email`, `url`, `currency` ou `reference`.","example":"enum"},"options":{"type":"string","nullable":true,"description":"Opções aceitas, como texto JSON. Preenchido em `enum` e `multiselect`.","example":"[\"varejo\",\"industria\",\"servicos\"]"},"group":{"type":"string","nullable":true,"description":"Grupo do campo no painel.","example":"Qualificação"},"archived_at":{"type":"string","format":"date-time","nullable":true,"description":"Data de arquivamento. `null` se o campo está em uso.","example":null},"created_at":{"type":"string","format":"date-time","nullable":false,"description":"Data de criação.","example":"2026-10-13T14:02:11.000Z"},"updated_at":{"type":"string","format":"date-time","nullable":false,"description":"Data da última alteração.","example":"2026-10-13T14:31:02.000Z"}}}},"next_cursor":{"type":"string","nullable":true,"example":"eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9","description":"Cursor da próxima página. Sempre `null`: o endpoint devolve tudo numa página."},"has_more":{"type":"boolean","example":false,"description":"`true` se há mais páginas. Sempre `false`: o endpoint devolve tudo numa página."},"sync_watermark":{"type":"string","format":"date-time","example":"2026-10-13T14:29:00.000Z","description":"Instante até o qual esta leitura está completa, igual em todas as páginas. Envie como `updated_since` na próxima sincronização."}}}}}},"401":{"description":"Chave ausente, inválida ou revogada.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"403":{"description":"API de dados desligada na conta, ou plano sem acesso.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"429":{"description":"Limite de requisições atingido (por minuto, por dia ou simultâneas). Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"500":{"description":"Erro inesperado. Repita com espera crescente.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"503":{"description":"Serviço temporariamente indisponível. Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}}},"security":[{"bearer":[]}],"summary":"Listar campos","tags":["Campos"]}},"/v1/deletions":{"get":{"description":"Lista contatos e conversas apagados nos últimos 90 dias, para replicar a exclusão na sua cópia.","operationId":"listDeletions","parameters":[{"name":"updated_since","required":false,"in":"query","schema":{"type":"string"},"description":"Retorna só registros apagados a partir deste instante: data e hora ISO 8601 com fuso, ou só a data (`AAAA-MM-DD`, meia-noite UTC). A busca recua 5 minutos para cobrir diferenças de relógio, então grave pela chave primária (`id`)."},{"name":"deleted_since","required":false,"in":"query","schema":{"type":"string"},"description":"Sinônimo de `updated_since`."},{"name":"cursor","required":false,"in":"query","schema":{"type":"string"},"description":"Valor de `next_cursor` da página anterior."},{"name":"limit","required":false,"in":"query","schema":{"type":"integer","minimum":1,"maximum":200,"default":100},"description":"Itens por página."}],"responses":{"200":{"headers":{"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"description":"Página de exclusões.","content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor","has_more","sync_watermark"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","object_type","object_id","deleted_at"],"properties":{"id":{"type":"string","nullable":false,"description":"Identificador único do registro.","example":"8d1e4b7a-2f3c-4d5e-a6b7-c8d9e0f1a2b3"},"object_type":{"type":"string","nullable":false,"description":"Tipo do registro apagado: `contact` ou `conversation`.","example":"contact"},"object_id":{"type":"string","nullable":false,"description":"Identificador do registro apagado.","example":"3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10"},"deleted_at":{"type":"string","format":"date-time","nullable":false,"description":"Data da exclusão.","example":"2026-10-14T09:12:40.000Z"}}}},"next_cursor":{"type":"string","nullable":true,"example":"eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9","description":"Cursor da próxima página, para enviar em `cursor`. `null` na última página."},"has_more":{"type":"boolean","example":true,"description":"`true` se há mais páginas."},"sync_watermark":{"type":"string","format":"date-time","example":"2026-10-13T14:29:00.000Z","description":"Instante até o qual esta leitura está completa, igual em todas as páginas. Envie como `updated_since` na próxima sincronização."}}}}}},"400":{"description":"Parâmetro inválido, ou cursor alterado ou de outra conta.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"401":{"description":"Chave ausente, inválida ou revogada.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"403":{"description":"API de dados desligada na conta, ou plano sem acesso.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"429":{"description":"Limite de requisições atingido (por minuto, por dia ou simultâneas). Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"500":{"description":"Erro inesperado. Repita com espera crescente.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}},"503":{"description":"Serviço temporariamente indisponível. Aguarde o `Retry-After`.","headers":{"Retry-After":{"description":"Segundos a aguardar antes de repetir a requisição.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requisições restantes no minuto.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Segundos até o minuto reiniciar.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"type":{"type":"string","example":"about:blank","description":"Sempre `about:blank`."},"title":{"type":"string","example":"Requisição inválida","description":"Resumo do erro, fixo por status."},"status":{"type":"integer","example":400,"description":"Status HTTP."},"detail":{"type":"string","example":"limit deve ser um número inteiro de 1 a 200.","description":"Explicação desta ocorrência."},"request_id":{"type":"string","example":"req-3f2a","description":"Identificador da requisição, para o suporte."}}}}}}},"security":[{"bearer":[]}],"summary":"Listar exclusões","tags":["Exclusões"]}}},"info":{"title":"API de dados da Ziala","description":"Leitura dos dados da sua conta (contatos, campos, conversas com origem de anúncio, mudanças de etapa e exclusões) para painéis e plataformas de dados.","version":"1","contact":{"name":"Suporte Ziala","url":"https://ziala.com.br","email":"contato@ziala.com.br"}},"tags":[{"name":"Conta","description":"A conta e os limites da chave."},{"name":"Contatos","description":"Contatos e os valores dos campos personalizados."},{"name":"Conversas","description":"Conversas, com origem e métricas."},{"name":"Funis","description":"Etapas dos funis e o histórico de mudanças de etapa."},{"name":"Campos","description":"Definições dos campos personalizados."},{"name":"Exclusões","description":"Registros apagados, para replicar a exclusão."}],"servers":[{"url":"https://api.ziala.com.br"}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"zk_live_…","type":"http","description":"Chave da API da conta, no formato `zk_live_…`."}},"schemas":{}}}