Campanhas

cancel_campaign

Escrita

Cancela uma campanha em rascunho, agendada ou em andamento: para os envios que ainda não saíram e encerra a sequência de todos os contatos. O que já foi enviado não volta.

Permissão

campaigns:write

Operação

campaigns.cancel

Módulo

campaigns

Parâmetros

campaignIdstringobrigatório

create_ad_campaign_with_ai

Escrita

Pede ao Gestor de Tráfego uma campanha de anúncio na Meta (Instagram e Facebook) a partir do briefing: destino, lugar, público, categoria especial, dois anúncios com texto do Copywriter e arte. Sai em RASCUNHO no Cognizy: nada vai para a Meta e nada gasta até a pessoa publicar (pausada) e ligar confirmando o valor diário. Leva cerca de 1 minuto e custa de 5 a 10 créditos de IA (10 com foto gerada). Use get_ad_campaign_draft com o id para acompanhar.

Permissão

campaigns:write

Operação

traffic_manager.create

Módulo

campaigns

Parâmetros

goalstringopcional

Onde a pessoa chega: WHATSAPP, LEAD_FORM (formulário), WEBSITE ou AUTO.AUTOWHATSAPPLEAD_FORMWEBSITE

subjectKindstringopcional

OFFER para oferta escrita no objetivo; BRAND para a marca.OFFERBRAND

subjectTitlestringopcional

O que se anuncia, curto.

objectivestringobrigatório

O que a campanha precisa alcançar e dizer.

offerstringopcional

Fatos que podem ser citados: preço, condição, prazo.

wherestringobrigatório

Onde anunciar, em palavras ("Campinas e região", "todo o Brasil").

dailyBudgetnumberobrigatório

Orçamento por dia em reais (mínimo R$ 6).

endDatestringopcional

Data de fim, AAAA-MM-DD.

websiteUrlstring (uri)opcional

photostringopcional

ai gera foto (5 créditos); none usa o modelo da marca.catalogainone

create_content_plan_with_ai

Escrita

Pede ao Estrategista o plano de conteúdo de um mês (pautas por rede e formato, conforme a cadência). Sai em RASCUNHO para revisar; nada vai para o calendário até a pessoa mandar. Leva de 1 a 3 minutos.

Permissão

campaigns:write

Operação

content_plan.generate

Parâmetros

monthstringobrigatório

Mês do plano, AAAA-MM (o atual ou um dos dois seguintes).

create_email_campaign

Escrita

Monta uma campanha de e-mail em RASCUNHO com o texto que você escreveu: de 1 a 4 e-mails (o servidor monta o visual com a marca da empresa, editável no editor), público por segmento ou etiquetas, assunto A/B opcional e a espera entre e-mails. Não envia nem agenda: confira, mande um teste (send_test_email) e dispare com launch_campaign ou schedule_campaign, que pedem aprovação. Sem custo de IA. Para a IA do Cognizy escrever, use create_email_campaign_with_ai.

Permissão

campaigns:write

Operação

email_campaigns.create

Módulo

campaigns

Parâmetros

namestringobrigatório

segmentIdstringopcional

Segmento salvo (list_segments).

tagIdsstring[]opcional

Ou: contatos com qualquer uma destas etiquetas.

ctaUrlstringopcional

Link do botão (https).

emailsobject[]obrigatório

emails[].subjectstringobrigatório

emails[].previewTextstringobrigatório

Linha que aparece depois do assunto na caixa de entrada.

emails[].headlinestringobrigatório

emails[].paragraphsstring[]obrigatório

emails[].bulletsstring[]opcional

emails[].ctaLabelstringobrigatório

Texto do botão.

emails[].closingstringopcional

emails[].subjectBstringopcional

Segundo assunto para teste A/B (metade recebe cada um).

emails[].delayDaysintegerobrigatório

Dias depois do e-mail anterior; o primeiro sai no disparo (0).

emails[].isBreakupbooleanopcional

Último e-mail, de despedida.

stopOnClickbooleanopcional

Parar a sequência de quem clicou (padrão: sim).

create_email_campaign_with_ai

Escrita

Pede ao E-mail Marketer uma campanha de e-mail completa a partir de um objetivo: público (segmento), de 1 a 4 e-mails, assunto A/B no primeiro e a sequência. Sai em RASCUNHO, nada é enviado; leva de 30 s a 1 min e custa 3 créditos de IA. Use get_email_campaign_draft com o id para acompanhar.

Permissão

campaigns:write

Operação

email_marketer.create

Módulo

campaigns

Parâmetros

goalstringobrigatório

promocaonovidadenewsletterreativacaoeventonutricao

objectivestringobrigatório

O que a campanha precisa alcançar e dizer.

offerstringopcional

Fatos que podem ser citados: preço, condição, prazo. Nada além disso é citado.

audiencestringopcional

Para quem, em palavras.

ctaUrlstringopcional

Link do botão (http/https).

deadlinestringopcional

Prazo da oferta ou data do evento, AAAA-MM-DD.

create_social_post_with_ai

Escrita

Pede um post pronto: o Copywriter escreve, o Diretor de arte faz a arte (carrossel com os slides do texto) e o post fica em RASCUNHO para revisar, escolher a rede e agendar. Nada é publicado. Leva cerca de 1 minuto; quem pediu é avisado quando fica pronto.

Permissão

campaigns:write

Operação

content_plan.draft_post

Parâmetros

topicstringobrigatório

formatstringopcional

FEEDCAROUSELSTORY

factsstringopcional

objectivestringopcional

engageleadssellinform

artTextobjectopcional

artText.titlestringopcional

artText.bodystringopcional

artText.ctastringopcional

scheduledAtstring (date-time)opcional

create_strategy_plan_with_ai

Escrita

Pede à Izy o plano estratégico de 90 dias em camadas (institucional, produto, região e setor), a partir da trava do funil, do mapa de cerco, da marca, dos produtos e das regiões. Sai em RASCUNHO para revisar e ativar; leva cerca de 1 minuto. Custa 5 créditos.

Permissão

campaigns:write

Operação

strategy_plan.generate

Parâmetros

Sem parâmetros.

dismiss_ad_recommendation

Escrita

Dispensa uma recomendação do Gestor de Tráfego. done: true = "já fiz no Gerenciador". Aplicar (mexe em orçamento) fica na tela.

Permissão

campaigns:write

Operação

ads.recommendations.dismiss

Parâmetros

recommendationIdstringobrigatório

donebooleanopcional

get_ad_campaign_draft

Leitura

Situação de um pedido ao Gestor de Tráfego: montando, pronto (com a campanha em rascunho, o destino, o lugar, os ângulos e o que revisar) ou falhou.

Permissão

campaigns:read

Operação

traffic_manager.get

Módulo

campaigns

Parâmetros

runIdstringobrigatório

get_ads_overview

Leitura

Visão do Gestor de Tráfego: campanhas acompanhadas, números dos últimos dias, a última conferência e as recomendações abertas, das mais importantes.

Permissão

campaigns:read

Operação

ads.overview

Parâmetros

Sem parâmetros.

get_campaign

Leitura

Uma campanha, com modelo de mensagem, segmento, departamento de atendimento e todos os contadores (enviadas, falhas, respostas, qualificados, agendados, descadastros, entregabilidade de e-mail).

Permissão

campaigns:read

Operação

campaigns.get

Módulo

campaigns

Parâmetros

campaignIdstringobrigatório

get_campaign_analytics

Leitura

Métricas de uma campanha: totais e a série de conversas geradas por hora, dia ou semana. Use para comparar variações e acompanhar o engajamento.

Permissão

campaigns:read

Operação

campaigns.analytics

Módulo

campaigns

Parâmetros

campaignIdstringobrigatório

granularitystringopcional

hourdayweek

get_campaign_reach

Leitura

Alcance por contato (não por mensagem) e por canal: quantos receberam, falharam, foram entregues, abriram e clicaram.

Permissão

campaigns:read

Operação

campaigns.reach

Módulo

campaigns

Parâmetros

campaignIdstringobrigatório

get_campaign_steps

Leitura

A sequência de uma campanha: cada passo com canal, espera depois do anterior, assunto, modelo e as variantes do teste A/B. Vazia = disparo único.

Permissão

campaigns:read

Operação

campaigns.steps

Módulo

campaigns

Parâmetros

campaignIdstringobrigatório

get_campaign_variant_performance

Leitura

Resultado do teste A/B por passo: envios, falhas e respostas de cada variante, taxa e se já há vencedor com significância.

Permissão

campaigns:read

Operação

campaigns.variant_performance

Módulo

campaigns

Parâmetros

campaignIdstringobrigatório

get_email_campaign_draft

Leitura

Situação de um pedido ao E-mail Marketer: montando, pronto (com a campanha em rascunho, o público, os assuntos e os avisos) ou falhou.

Permissão

campaigns:read

Operação

email_marketer.get

Módulo

campaigns

Parâmetros

runIdstringobrigatório

get_email_template

Leitura

Um modelo de e-mail: assunto, prévia e o texto do e-mail (versão sem formatação). O visual fica no editor da tela.

Permissão

campaigns:read

Operação

email_templates.get

Módulo

campaigns

Parâmetros

templateIdstringobrigatório

get_google_ads_report

Leitura

Relatório das campanhas do Google Ads no período: gasto, impressões, cliques, conversões, custo por conversão e o que virou conversa, lead e venda no Cognizy. Padrão: últimos 30 dias.

Permissão

campaigns:read

Operação

google_ads.report

Parâmetros

dateFromstringopcional

AAAA-MM-DD (Brasília).

dateTostringopcional

AAAA-MM-DD, inclusivo.

get_meta_ads_report

Leitura

Relatório das campanhas da Meta (Facebook/Instagram) no período: gasto, impressões, cliques, CTR, custo por resultado e o que virou conversa, lead e venda no Cognizy. Padrão: últimos 30 dias.

Permissão

campaigns:read

Operação

meta_ads.report

Parâmetros

dateFromstringopcional

AAAA-MM-DD (Brasília).

dateTostringopcional

AAAA-MM-DD, inclusivo.

launch_campaign

EscritaPede aprovação

Dispara uma campanha em rascunho para o público dela — a escrita de maior alcance: muitos contatos de uma vez. Vinda de chave de API ou de agente, NÃO dispara na hora: vai para a fila de aprovação (o pedido vence em 1 h) e só sai quando um administrador aprova. Diga que aguarda aprovação.

Permissão

campaigns:write

Operação

campaigns.launch

Módulo

campaigns

As que pedem aprovação não executam na hora: viram um pedido em Para revisar e na aba Aprovações de IA.

Parâmetros

campaignIdstringobrigatório

Campanha em rascunho (DRAFT).

list_ad_recommendations

Leitura

Recomendações abertas de uma campanha de anúncios do Cognizy: o que fazer, por quê (com os números) e a prioridade.

Permissão

campaigns:read

Operação

ads.recommendations.list

Parâmetros

adCampaignIdstringobrigatório

list_campaign_send_logs

Leitura

Envio contato a contato: status (QUEUED, SENT, FAILED, SKIPPED) e o motivo da falha — para entender por que um e-mail não saiu.

Permissão

campaigns:read

Operação

campaigns.send_logs

Módulo

campaigns

Parâmetros

campaignIdstringobrigatório

statusstringopcional

QUEUEDSENTFAILEDSKIPPED

pageintegeropcional

limitintegeropcional

list_campaigns

Leitura

Campanhas de marketing da empresa, paginadas, com filtro por status e canal e os contadores de envio e resposta.

Permissão

campaigns:read

Operação

campaigns.list

Módulo

campaigns

Parâmetros

statusstringopcional

DRAFTSCHEDULEDRUNNINGCOMPLETEDCANCELLED

channelstringopcional

WEB_CHATWHATSAPPEMAILINSTAGRAMMESSENGERTELEGRAMAPI

pageintegeropcional

limitintegeropcional

list_email_templates

Leitura

Modelos de e-mail da empresa: nome, assunto, prévia e quando mudou.

Permissão

campaigns:read

Operação

email_templates.list

Módulo

campaigns

Parâmetros

Sem parâmetros.

list_segments

Leitura

Segmentos salvos (públicos de campanha): id, nome e descrição. Use o id em create_email_campaign.

Permissão

campaigns:read

Operação

segments.list

Módulo

campaigns

Parâmetros

Sem parâmetros.

pause_meta_ad_campaign

Escrita

Pausa uma campanha da Meta (para o gasto na hora). Reativar e mudar orçamento ficam na tela.

Permissão

campaigns:write

Operação

meta_ads.campaigns.pause

Parâmetros

campaignIdstringobrigatório

Id da campanha na Meta (do relatório).

schedule_campaign

EscritaPede aprovação

Agenda o disparo de uma campanha em rascunho para uma data e hora (sem fuso = Brasília; de 10 min a 90 dias à frente). Vinda de chave de API ou de agente, vai para a fila de aprovação e só fica agendada quando um administrador aprova. Para tirar o agendamento: unschedule_campaign.

Permissão

campaigns:write

Operação

campaigns.schedule

Módulo

campaigns

As que pedem aprovação não executam na hora: viram um pedido em Para revisar e na aba Aprovações de IA.

Parâmetros

campaignIdstringobrigatório

sendAtstringobrigatório

send_test_email

Escrita

Manda um e-mail de teste do modelo para alguém da equipe (padrão: quem é dono da chave), com dados de exemplo nas variáveis. Só para endereços de membros da empresa.

Permissão

campaigns:write

Operação

email_templates.test_send

Módulo

campaigns

Parâmetros

templateIdstringobrigatório

tostring (email)opcional

unschedule_campaign

Escrita

Tira o agendamento: a campanha volta para rascunho e não sai sozinha.

Permissão

campaigns:write

Operação

campaigns.unschedule

Módulo

campaigns

Parâmetros

campaignIdstringobrigatório

update_email_campaign

Escrita

Ajusta uma campanha ainda não disparada (rascunho ou agendada): nome, público (segmento ou etiquetas) ou parar quem clicou/respondeu. O texto de cada e-mail muda em update_email_template.

Permissão

campaigns:write

Operação

email_campaigns.update

Módulo

campaigns

Parâmetros

campaignIdstringobrigatório

namestringopcional

segmentIdstringopcional

Segmento salvo (list_segments).

tagIdsstring[]opcional

Ou: contatos com qualquer uma destas etiquetas.

stopOnClickbooleanopcional

stopOnReplybooleanopcional

update_email_template

Escrita

Muda um modelo de e-mail. Só assunto e/ou prévia: troca só isso. Com headline e paragraphs: refaz o e-mail inteiro com a marca (mande também ctaLabel e o ctaUrl, e saiba que o ajuste visual feito no editor se perde). Vale para os próximos envios de toda campanha que usa o modelo.

Permissão

campaigns:write

Operação

email_templates.update

Módulo

campaigns

Parâmetros

templateIdstringobrigatório

subjectstringopcional

previewTextstringopcional

Linha que aparece depois do assunto na caixa de entrada.

headlinestringopcional

paragraphsstring[]opcional

bulletsstring[]opcional

ctaLabelstringopcional

Texto do botão.

ctaUrlstringopcional

Link do botão (https).

closingstringopcional