🏠properties_listLeitura

Lista todas as propriedades do anfitrião com status e detalhes de configuração.

Clique para expandir parâmetros →

Nenhum parâmetro necessário.

🏠properties_get_analyticsLeitura

Analytics de receita e ocupação do portfólio em um período configurável.

Clique para expandir parâmetros →

period_daysintegerPeríodo retroativo em dias (7–90).

👤guests_queryLeitura

Consulta registros do CRM de hóspedes com filtros de gasto e estadias. Somente leitura — não cria pastas nem campanhas.

Clique para expandir parâmetros →

limitintegerMáximo de resultados (1–12).

min_spendnumberGasto total mínimo (agnóstico de moeda).

min_spend_brlnumberGasto total mínimo em BRL.

min_staysintegerMínimo de estadias concluídas.

👤guests_get_profileLeitura

Perfil completo do hóspede com status de fidelidade e resumo do histórico de estadias.

Clique para expandir parâmetros →

guest_iduuidobrigatórioUUID do hóspede.

👤guests_get_segment_summaryLeitura

Contagens agregadas de segmentos de hóspedes por faixa de gasto e status de repetição.

Clique para expandir parâmetros →

Nenhum parâmetro necessário.

👤guests_tagEscrita

Aplica até 12 tags operacionais a um registro de hóspede. Não cria pastas.

Clique para expandir parâmetros →

guest_iduuidHóspede alvo.

tagsstring[]Array de rótulos de tag (máx. 12).

👤guests_create_folderEscrita

Cria uma pasta de hóspedes no CRM (segmento manual). Idempotente — retorna a pasta existente se o nome coincidir.

Clique para expandir parâmetros →

namestringNome da pasta (1–80 caracteres).

descriptionstringDescrição da pasta (máx. 240 caracteres).

color_hexstringCor da pasta em hex.

👤guests_add_to_folderEscrita

Adiciona até 12 hóspedes a uma pasta existente no CRM. Chame após guests_create_folder.

Clique para expandir parâmetros →

folder_iduuidPasta alvo.

guest_idsuuid[]Array de UUIDs de hóspedes (1–12).

👤guests_list_foldersLeitura

Lista todas as pastas de hóspedes no CRM (segmentos manuais) com contagem de membros.

Clique para expandir parâmetros →

Nenhum parâmetro necessário.

👤guests_get_message_historyLeitura

Visualiza o histórico completo de comunicação de um hóspede em email, WhatsApp e SMS.

Clique para expandir parâmetros →

guest_iduuidobrigatórioHóspede alvo.

channelenumemail | whatsapp | sms | all

limitintegerMáximo de mensagens (1–50).

sincedatetimeData limite ISO 8601.

📅reservations_listLeitura

Lista reservas recentes em todo o portfólio.

Clique para expandir parâmetros →

limitintegerMáximo de resultados (1–12).

statusstringFiltrar por status da reserva.

📅reservations_check_availabilityLeitura

Verifica se uma propriedade está disponível em uma janela de datas específica.

Clique para expandir parâmetros →

property_idstringPropriedade alvo.

check_indateData de chegada (YYYY-MM-DD).

check_outdateData de saída (YYYY-MM-DD).

📅reservations_get_gap_nightsLeitura

Identifica noites ociosas órfãs entre reservas — janelas curtas de vacância ideais para ofertas segmentadas.

Clique para expandir parâmetros →

property_idstringPropriedade específica (opcional — todas se omitido).

horizon_daysintegerJanela de antecedência (7–90 dias).

📅reservations_create_reservationEscrita

Cria um bloqueio manual de reserva no calendário de uma propriedade.

Clique para expandir parâmetros →

property_idstringPropriedade alvo.

guest_emailemailEndereço de email do hóspede.

check_indateData de chegada.

check_outdateData de saída.

📅reservations_create_quoteEscrita

Prepara um orçamento de estadia para revisão do anfitrião. Nenhum bloqueio de calendário é criado.

Clique para expandir parâmetros →

Nenhum parâmetro necessário.

📧campaigns_create_email_campaignAssíncrono

Cria um rascunho de campanha de email com corpo HTML completo, merge fields e segmentação de audiência. Nunca envia — sempre começa como rascunho.

Clique para expandir parâmetros →

subjectstringobrigatórioAssunto do email (5–200 caracteres).

body_htmlstringobrigatórioCorpo HTML completo do email com merge fields como {{guest_name}}.

preheaderstringTexto de preview na caixa de entrada.

cta_urlurlURL de destino do botão CTA.

cta_labelstringTexto do botão CTA (máx. 60 caracteres).

guest_folder_iduuidPasta de audiência alvo.

namestringRótulo interno da campanha.

goalstringMetadados do objetivo da campanha.

📧campaigns_create_whatsapp_campaignAssíncrono

Cria um rascunho de campanha WhatsApp via IA. Executa como job assíncrono.

Clique para expandir parâmetros →

goalstringObjetivo da campanha para geração por IA.

📧campaigns_send_campaignAprovação

Envia uma campanha preparada para sua audiência alvo. Exige token de aprovação.

Clique para expandir parâmetros →

campaign_iduuidCampanha a enviar.

approval_tokenstringToken de aprovação de curta duração.

📧campaigns_send_to_guestAprovação

Envia uma campanha ou mensagem customizada a um único hóspede. Suporta variáveis de merge e substituições de assunto/corpo.

Clique para expandir parâmetros →

guest_iduuidobrigatórioHóspede alvo.

approval_tokenstringobrigatórioToken de aprovação com escopo restrito.

campaign_iduuidTemplate de campanha a usar.

channelenumemail | whatsapp

merge_varsobjectVariáveis de merge customizadas.

override_subjectstringSubstituir o assunto da campanha.

override_bodystringSubstituir o corpo da campanha.

💬messaging_get_or_create_threadEscrita

Obtém ou cria uma thread de mensagens para um hóspede no WhatsApp, SMS ou email.

Clique para expandir parâmetros →

guest_iduuidobrigatórioHóspede alvo.

channelenumwhatsapp | sms | email

create_if_missingbooleanCriar thread se não existir.

💬messaging_prepare_whatsapp_messageEscrita

Rascunha uma mensagem WhatsApp para revisão do anfitrião. Não envia.

Clique para expandir parâmetros →

thread_iduuidThread WhatsApp.

messagestringConteúdo da mensagem (máx. 4096 caracteres).

💬messaging_send_whatsapp_messageAprovação

Envia uma mensagem WhatsApp a um hóspede. Exige token de aprovação.

Clique para expandir parâmetros →

thread_iduuidThread alvo.

messagestringConteúdo da mensagem (máx. 4096 caracteres).

approval_tokenstringToken de aprovação.

💬transactional_email_sendAprovação

Envia um email transacional a um hóspede via Resend. Exige token de aprovação quando send_immediately=true. Respeita o status de descadastro do hóspede.

Clique para expandir parâmetros →

to_emailemailobrigatórioEmail do destinatário.

subjectstringobrigatórioAssunto do email (máx. 200 caracteres).

body_htmlstringobrigatórioCorpo HTML do email.

to_namestringNome de exibição do destinatário.

body_textstringFallback em texto simples.

reply_toemailEndereço de reply-to.

merge_varsobjectVariáveis de template.

approval_tokenstringObrigatório para envio imediato.

send_immediatelybooleanEnviar agora (vs enfileirar).

allow_externalbooleanPermitir destinatários fora do CRM.

📸content_create_instagram_postAssíncrono

Enfileira um carrossel no Instagram no SparkOS Studio. Suporta 2–10 slides com título, subtítulo, corpo e URL de imagem. Nunca publica — o anfitrião revisa e aprova no Studio.

Clique para expandir parâmetros →

property_idstringobrigatórioPropriedade a associar.

captionstringLegenda do Instagram (20–2200 caracteres).

slidesobject[]2–10 slides: { title, subtitle?, body?, image_url? }

goalstringObjetivo do conteúdo.

themestringLegado — monta slides automaticamente quando slides[] é omitido.

schedule_days_outintegerAgendar automaticamente dias à frente (1–30).

📸content_schedule_instagram_postAprovação

Agenda um post Instagram enfileirado para publicação. Exige token de aprovação.

Clique para expandir parâmetros →

post_iduuidPost a agendar.

scheduled_atdatetimeHorário de publicação (ISO 8601).

approval_tokenstringToken de aprovação.

📊analytics_analyze_portfolioAssíncrono

Análise profunda de portfólio com IA. Executa como job assíncrono — consulte jobs_get_status para resultados.

Clique para expandir parâmetros →

Nenhum parâmetro necessário.

📊analytics_forecast_revenueAssíncrono

Previsão de receita com IA em um horizonte configurável. Job assíncrono.

Clique para expandir parâmetros →

horizon_daysintegerHorizonte de previsão (30–365 dias).

⭐loyalty_get_tier_summaryLeitura

Contagem de hóspedes por tier de fidelidade em todo o portfólio.

Clique para expandir parâmetros →

Nenhum parâmetro necessário.

⭐loyalty_get_guest_tierLeitura

Obtém o tier de fidelidade atual de um hóspede específico.

Clique para expandir parâmetros →

guest_iduuidHóspede alvo.

⭐loyalty_update_guest_tierAprovação

Atualiza o tier de fidelidade de um hóspede. Exige token de aprovação.

Clique para expandir parâmetros →

guest_iduuidHóspede alvo.

tier_iduuidNovo tier de fidelidade.

approval_tokenstringToken de aprovação.

⚡automation_create_ruleEscrita

Cria um rascunho de regra de automação. Exige token de aprovação.

Clique para expandir parâmetros →

namestringNome da regra.

triggerstringGatilho de evento.

approval_tokenstringToken de aprovação.

⚡automation_activateAprovação

Ativa, dispara uma vez ou testa uma regra de automação.

Clique para expandir parâmetros →

rule_iduuidobrigatórioRegra alvo.

activation_modeenumobrigatórioenable | trigger_once | test

approval_tokenstringObrigatório para enable/trigger_once.

target_guest_iduuidHóspede para trigger_once/test.

💳payments_create_payment_linkEscrita

Cria um rascunho de link de pagamento seguro vinculado a uma reserva. Exige token de aprovação.

Clique para expandir parâmetros →

reservation_iduuidReserva associada.

amountnumberValor do pagamento.

approval_tokenstringToken de aprovação.

🔐approval_token_requestEscrita

Gera um token de aprovação de curta duração, com escopo restrito, para ações Tier 3 (envio de campanha, WhatsApp, email transacional, automação).

Clique para expandir parâmetros →

action_typeenumobrigatóriocampaign_send | campaigns_send_to_guest | automation_activate | whatsapp_send | transactional_email

reasonstringobrigatórioJustificativa legível (3–500 caracteres).

scopeobjectRestrições de escopo opcionais.

ttl_secondsintegerValidade do token (60–600 segundos).

⏳jobs_get_statusLeitura

Consulta status e resultado de job assíncrono. Obrigatório após qualquer ferramenta assíncrona — não marque tarefas como concluídas até status=completed.

Clique para expandir parâmetros →

job_iduuidUUID do job da chamada inicial.

🤝marketplace_get_partnersLeitura

Lista parceiros locais Spark Nearby para suas propriedades.

Clique para expandir parâmetros →

Nenhum parâmetro necessário.

SparkOS Documentação

O que é o SparkOS?

🏠 Gestão de Propriedades

👤 CRM de Hóspedes

📧 Campanhas Multicanal

💬 Mensagens Diretas

📊 Analytics com IA

📸 Studio (Conteúdo)

Guia de Início Rápido

Conecte o SparkOS no Claude

Explore Suas Propriedades

Consulte Seus Hóspedes

Crie uma Campanha

Entenda o Sistema de Aprovação

Todas as 36 Ferramentas

🏠 Gestão de Propriedades

👤 Gestão de Hóspedes

📅 Operações de Reserva

📧 Campanhas de Email e WhatsApp

💬 Mensagens Diretas

📸 Criação de Conteúdo

📊 Analytics e Previsões

⭐ Programa de Fidelidade

⚡ Regras de Automação

💳 Links de Pagamento

Conceitos-Chave

🔐 Tokens de Aprovação

⏳ Jobs Assíncronos

📂 Pastas de Hóspedes

🏷️ Tags vs Pastas

📨 Merge Fields

💰 Filtros de Moeda

🔄 Email Transacional vs Campanha

📅 Noites Ociosas

🤝 Spark Nearby