Campaigns

cancel_campaign

Write

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.

Permission

campaigns:write

Operation

campaigns.cancel

Module

campaigns

Parameters

campaignIdstringrequired

create_ad_campaign_with_ai

Write

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.

Permission

campaigns:write

Operation

traffic_manager.create

Module

campaigns

Parameters

goalstringoptional

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

subjectKindstringoptional

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

subjectTitlestringoptional

O que se anuncia, curto.

objectivestringrequired

O que a campanha precisa alcançar e dizer.

offerstringoptional

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

wherestringrequired

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

dailyBudgetnumberrequired

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

endDatestringoptional

Data de fim, AAAA-MM-DD.

websiteUrlstring (uri)optional

photostringoptional

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

create_content_plan_with_ai

Write

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.

Permission

campaigns:write

Operation

content_plan.generate

Parameters

monthstringrequired

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

create_email_campaign

Write

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.

Permission

campaigns:write

Operation

email_campaigns.create

Module

campaigns

Parameters

namestringrequired

segmentIdstringoptional

Segmento salvo (list_segments).

tagIdsstring[]optional

Ou: contatos com qualquer uma destas etiquetas.

ctaUrlstringoptional

Link do botão (https).

emailsobject[]required

emails[].subjectstringrequired

emails[].previewTextstringrequired

Linha que aparece depois do assunto na caixa de entrada.

emails[].headlinestringrequired

emails[].paragraphsstring[]required

emails[].bulletsstring[]optional

emails[].ctaLabelstringrequired

Texto do botão.

emails[].closingstringoptional

emails[].subjectBstringoptional

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

emails[].delayDaysintegerrequired

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

emails[].isBreakupbooleanoptional

Último e-mail, de despedida.

stopOnClickbooleanoptional

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

create_email_campaign_with_ai

Write

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.

Permission

campaigns:write

Operation

email_marketer.create

Module

campaigns

Parameters

goalstringrequired

promocaonovidadenewsletterreativacaoeventonutricao

objectivestringrequired

O que a campanha precisa alcançar e dizer.

offerstringoptional

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

audiencestringoptional

Para quem, em palavras.

ctaUrlstringoptional

Link do botão (http/https).

deadlinestringoptional

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

create_social_post_with_ai

Write

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.

Permission

campaigns:write

Operation

content_plan.draft_post

Parameters

topicstringrequired

formatstringoptional

FEEDCAROUSELSTORY

factsstringoptional

objectivestringoptional

engageleadssellinform

artTextobjectoptional

artText.titlestringoptional

artText.bodystringoptional

artText.ctastringoptional

scheduledAtstring (date-time)optional

create_strategy_plan_with_ai

Write

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.

Permission

campaigns:write

Operation

strategy_plan.generate

Parameters

No parameters.

dismiss_ad_recommendation

Write

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

Permission

campaigns:write

Operation

ads.recommendations.dismiss

Parameters

recommendationIdstringrequired

donebooleanoptional

get_ad_campaign_draft

Read

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.

Permission

campaigns:read

Operation

traffic_manager.get

Module

campaigns

Parameters

runIdstringrequired

get_ads_overview

Read

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.

Permission

campaigns:read

Operation

ads.overview

Parameters

No parameters.

get_campaign

Read

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

Permission

campaigns:read

Operation

campaigns.get

Module

campaigns

Parameters

campaignIdstringrequired

get_campaign_analytics

Read

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.

Permission

campaigns:read

Operation

campaigns.analytics

Module

campaigns

Parameters

campaignIdstringrequired

granularitystringoptional

hourdayweek

get_campaign_reach

Read

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

Permission

campaigns:read

Operation

campaigns.reach

Module

campaigns

Parameters

campaignIdstringrequired

get_campaign_steps

Read

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.

Permission

campaigns:read

Operation

campaigns.steps

Module

campaigns

Parameters

campaignIdstringrequired

get_campaign_variant_performance

Read

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

Permission

campaigns:read

Operation

campaigns.variant_performance

Module

campaigns

Parameters

campaignIdstringrequired

get_email_campaign_draft

Read

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.

Permission

campaigns:read

Operation

email_marketer.get

Module

campaigns

Parameters

runIdstringrequired

get_email_template

Read

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.

Permission

campaigns:read

Operation

email_templates.get

Module

campaigns

Parameters

templateIdstringrequired

get_google_ads_report

Read

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.

Permission

campaigns:read

Operation

google_ads.report

Parameters

dateFromstringoptional

AAAA-MM-DD (Brasília).

dateTostringoptional

AAAA-MM-DD, inclusivo.

get_meta_ads_report

Read

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.

Permission

campaigns:read

Operation

meta_ads.report

Parameters

dateFromstringoptional

AAAA-MM-DD (Brasília).

dateTostringoptional

AAAA-MM-DD, inclusivo.

launch_campaign

WriteNeeds approval

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.

Permission

campaigns:write

Operation

campaigns.launch

Module

campaigns

Tools that wait for approval don't run right away: they become a request in To review and in the AI approvals tab.

Parameters

campaignIdstringrequired

Campanha em rascunho (DRAFT).

list_ad_recommendations

Read

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

Permission

campaigns:read

Operation

ads.recommendations.list

Parameters

adCampaignIdstringrequired

list_campaign_send_logs

Read

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

Permission

campaigns:read

Operation

campaigns.send_logs

Module

campaigns

Parameters

campaignIdstringrequired

statusstringoptional

QUEUEDSENTFAILEDSKIPPED

pageintegeroptional

limitintegeroptional

list_campaigns

Read

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

Permission

campaigns:read

Operation

campaigns.list

Module

campaigns

Parameters

statusstringoptional

DRAFTSCHEDULEDRUNNINGCOMPLETEDCANCELLED

channelstringoptional

WEB_CHATWHATSAPPEMAILINSTAGRAMMESSENGERTELEGRAMAPI

pageintegeroptional

limitintegeroptional

list_email_templates

Read

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

Permission

campaigns:read

Operation

email_templates.list

Module

campaigns

Parameters

No parameters.

list_segments

Read

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

Permission

campaigns:read

Operation

segments.list

Module

campaigns

Parameters

No parameters.

pause_meta_ad_campaign

Write

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

Permission

campaigns:write

Operation

meta_ads.campaigns.pause

Parameters

campaignIdstringrequired

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

schedule_campaign

WriteNeeds approval

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.

Permission

campaigns:write

Operation

campaigns.schedule

Module

campaigns

Tools that wait for approval don't run right away: they become a request in To review and in the AI approvals tab.

Parameters

campaignIdstringrequired

sendAtstringrequired

send_test_email

Write

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.

Permission

campaigns:write

Operation

email_templates.test_send

Module

campaigns

Parameters

templateIdstringrequired

tostring (email)optional

unschedule_campaign

Write

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

Permission

campaigns:write

Operation

campaigns.unschedule

Module

campaigns

Parameters

campaignIdstringrequired

update_email_campaign

Write

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.

Permission

campaigns:write

Operation

email_campaigns.update

Module

campaigns

Parameters

campaignIdstringrequired

namestringoptional

segmentIdstringoptional

Segmento salvo (list_segments).

tagIdsstring[]optional

Ou: contatos com qualquer uma destas etiquetas.

stopOnClickbooleanoptional

stopOnReplybooleanoptional

update_email_template

Write

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.

Permission

campaigns:write

Operation

email_templates.update

Module

campaigns

Parameters

templateIdstringrequired

subjectstringoptional

previewTextstringoptional

Linha que aparece depois do assunto na caixa de entrada.

headlinestringoptional

paragraphsstring[]optional

bulletsstring[]optional

ctaLabelstringoptional

Texto do botão.

ctaUrlstringoptional

Link do botão (https).

closingstringoptional