Flux Control

Arquiva (exclusão lógica) ou restaura um fluxo, conforme o valor de archived. Use essa ferramenta quando: o usuário quer arquivar um fluxo (archived: true) ou restaurá-lo (archived: false). Efeitos colaterais: quando archived é true, executa exclusão lógica do fluxo (soft delete); quando false, restaura o fluxo arquivado. Permissões: pipes:self:delete (pipes). Dados opcionais (@include): archived (default: false): quando true, arquiva o fluxo (deletePipe); quando false, restaura o fluxo arquivado (undeletePipe).

set_pipe_archived

Arquiva (soft delete) ou restaura um template, alternando seu estado de arquivado conforme o valor de archived. Use essa ferramenta quando: o usuário quer arquivar (soft delete) um template quando archived for true, ou restaurar um template arquivado quando archived for false. Antes de usar: ao arquivar (archived: true), consulte get_template_usage para saber quais etapas e automações utilizam o template antes de arquivá-lo. Efeitos colaterais: quando archived é true, executa exclusão lógica (soft delete) marcando o template como archived: ele some das listagens padrão e deixa de ser usado em novas execuções; quando archived é false, limpa o estado de arquivado e o template volta a aparecer nas listagens e pode ser vinculado a etapas e usado em automações novamente. Permissões: pipes:templates:archive (pipes). Dados opcionais (@include): archived (default: false): quando true, arquiva o template e retorna o template arquivado; quando false, restaura o template e retorna o template desarquivado (id, name, type, archived, pipeId, updatedAt).

set_template_archived

Atribui ao card um responsável escolhido automaticamente entre os membros elegíveis. Com um modelo de atribuição, os candidatos são os membros dele e a distribuição segue o modo do modelo (revezamento ou menor carga). Sem modelo, os candidatos vêm da configuração do fluxo e a escolha é sempre por menor carga de cards abertos. Quando todos os candidatos elegíveis já são responsáveis do card, nada é alterado e o usuário escolhido volta em branco. Use essa ferramenta quando: o usuário quer que o próprio Flux escolha o responsável de um card, por revezamento ou por menor carga, em vez de indicar uma pessoa. Não use quando: o usuário já sabe quem deve ficar responsável pelo card: nesse caso use add_card_assignee. Antes de usar: a conta precisa ter a flag feature:automatic-assignment ativa (confira com get_account e includeFeatureFlags: true); com modelo, obtenha o templateId em list_templates (filtrando templateType: assignment); sem modelo, os candidatos são os de get_pipe_assignment_settings. Efeitos colaterais: cria o vínculo entre o card e o responsável escolhido, que passa a receber as notificações do card; no modo de revezamento, consome a vez do membro escolhido no modelo. Use a ferramenta search com CreateCardAssigneeViaAssignmentInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:cards:update_all (pipes), pipes:cards:update_limited (pipes).

assign_card_automatically

Atualiza os metadados (nome e descrição) de uma automação V2 existente. Não altera gatilho, condições, ações nem status; para isso use batchUpsertAutomationV2Data ou updateAutomationV2Status. Use essa ferramenta quando: o usuário quer renomear ou alterar a descrição de uma automação V2 existente. Antes de usar: consulte get_automation para obter os valores atuais da automação e montar o input apenas com os campos que devem mudar. Efeitos colaterais: atualiza apenas os metadados (nome e descrição) da automação; gatilhos, condições e ações não são afetados. Use a ferramenta search com UpdateAutomationV2Input para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: global:automations_v2:update (global), pipes:automations_v2:update (pipes).

update_automation

Define o papel (cargo) de um usuário. Por padrão altera o cargo de um membro dentro de um fluxo, mas, conforme o roleEntityContext informado, também pode atribuir cargos de escopo global ou de banco de dados. Use essa ferramenta quando: o usuário quer alterar o cargo (papel) de um membro existente em um fluxo (por exemplo, promover de pipe_reader para pipe_editor); informe roleEntityContext para atribuir cargos em escopo global ou de banco de dados. Antes de usar: consulte get_pipe (com includeMembers: true) para identificar o membro e o papel atual. Efeitos colaterais: substitui o cargo do usuário no escopo indicado (o fluxo por padrão, ou o escopo global ou de banco de dados quando roleEntityContext é informado); as permissões efetivas do usuário passam a refletir as do novo cargo. Use a ferramenta search com RoleEntityContextInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Argumentos: roleEntityContext: O contexto da entidade do papel (pipeId ou databaseId) do qual remover o papel do usuário. Permissões: databases:roles:manage_users (databases), global:roles:manage_users (global), pipes:roles:manage_users (pipes).

update_pipe_member

Atualiza o conteúdo de um comentário existente. Apenas o autor original do comentário pode editá-lo. Substitui o conteúdo e atualiza `updatedAt`; autor e card permanecem inalterados. Use essa ferramenta quando: o usuário quer editar o conteúdo de um comentário existente em um card. Antes de usar: consulte list_card_comments para obter o commentId atual. Efeitos colaterais: substitui o conteúdo do comentário e atualiza updatedAt; o comentário permanece associado ao mesmo autor e card. Use a ferramenta search com UpdateCardCommentInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento.

update_card_comment

Grava a configuração da distribuição automática sem modelo do fluxo: escopo dos candidatos (all_members ou update_permission_only), se times são candidatos e a lista de membros excluídos. É por fluxo, não por automação. Use essa ferramenta quando: o usuário quer definir quem entra na distribuição automática de responsáveis de um fluxo quando a automação não aponta para um modelo de atribuição — inclusive excluir pessoas do sorteio. Envie a configuração completa: a lista de excluídos substitui a anterior. Não use quando: a distribuição deve considerar apenas um subconjunto ordenado de pessoas: isso é um modelo de atribuição, criado com create_template_assignment. Antes de usar: a conta precisa ter a flag feature:automatic-assignment ativa (confira com get_account e includeFeatureFlags: true), e includeTeams: true também exige feature:automatic-assignment-teams; consulte get_pipe_assignment_settings para os valores atuais, porque a gravação substitui a configuração inteira. Efeitos colaterais: regrava a configuração inteira da distribuição sem modelo do fluxo, criando a linha na primeira gravação; passa a valer para todas as automações do fluxo que distribuem sem modelo, sem alterar atribuições já feitas. Use a ferramenta search com UpdatePipeAssignmentSettingsInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Argumentos: input: Configuração completa a ser gravada. Permissões: pipes:self:manage_users (pipes).

update_pipe_assignment_settings

Atualiza (ou limpa) a descrição de um card. O card precisa pertencer à conta autenticada e não estar arquivado, somente leitura ou bloqueado. Eventos de log diferenciam adição, alteração e remoção da descrição. Use essa ferramenta quando: o usuário quer alterar (ou limpar) a descrição textual de um card. Efeitos colaterais: substitui o campo description do card; envie newDescription como null para remover a descrição. Use a ferramenta search com UpdateCardDescriptionInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:cards:update_all (pipes), pipes:cards:update_limited (pipes).

update_card_description

Atualiza uma etapa existente. A etapa precisa pertencer à conta autenticada e não pode estar arquivada. Atualizações são parciais: campos omitidos preservam o valor atual. Quando o tipo efetivo passa a ser "Cancelado", o formulário e o prazo são desvinculados, todos os modelos de tarefa associados à etapa são removidos e os flags de revisão, recebimento direto, movimentação automática e modo de confirmação ao mover card são forçados para os valores adequados. Use essa ferramenta quando: o usuário quer editar dados de uma etapa, como nome, cor, descrição, ordem ou regras de revisão. Antes de usar: consulte get_stage para obter os valores atuais da etapa e montar o input apenas com os campos que devem mudar. Efeitos colaterais: alterações em campos como done, reviewRequired ou moveCardToNextStageWhenDone podem afetar o comportamento de cards já presentes na etapa. Use a ferramenta search com UpdateStageInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:stages:update (pipes).

update_stage

Atualiza uma etiqueta. Use essa ferramenta quando: o usuário quer editar o nome ou a cor de uma etiqueta existente. Antes de usar: consulte get_labels_by_ids (ou list_labels filtrando por pipeId) para obter os dados atuais da etiqueta antes de editá-la. Efeitos colaterais: as alterações de nome e cor refletem imediatamente em todos os cards e tarefas que já usam essa etiqueta. Use a ferramenta search com UpdateLabelInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:labels:update (pipes).

update_label

Atualiza um fluxo existente. Use essa ferramenta quando: o usuário quer alterar dados de um fluxo, como nome, cor, ícone, descrição, privacidade ou comportamentos de cards. Antes de usar: consulte get_pipe para obter os valores atuais do fluxo e montar o input apenas com os campos que devem mudar. Efeitos colaterais: ao definir startFormId, valida se o formulário pertence à mesma conta antes de associá-lo como formulário inicial. Use a ferramenta search com UpdatePipeInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:self:update (pipes).

update_pipe

Atualiza o formulário de uma etapa. Use essa ferramenta quando: o usuário quer editar as questões do formulário de uma etapa específica do fluxo. Antes de usar: consulte get_form para obter os ids e a estrutura atual das questões e montar o input corretamente. Efeitos colaterais: substitui o conjunto de questões do formulário da etapa conforme o input. Para remover uma questão existente envie _destroy: true; novas questões são criadas e existentes são atualizadas pelo id. Use a ferramenta search com UpdateStageFormInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:forms:update (pipes).

update_stage_form

Atualiza o formulário inicial de um fluxo. Use essa ferramenta quando: o usuário quer editar o formulário inicial (de solicitação) de um fluxo, definindo as questões preenchidas ao criar um card. Antes de usar: consulte get_form para obter os ids e a estrutura atual das questões e montar o input corretamente. Efeitos colaterais: substitui o conjunto de questões do formulário inicial conforme o input. Para remover uma questão existente envie _destroy: true no item correspondente; novas questões são criadas e questões existentes são atualizadas pelo id. Use a ferramenta search com UpdateInitialFormInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:forms:update (pipes).

update_initial_form

Edita um modelo de documento existente. Substitui integralmente o corpo pela árvore informada e atualiza nome, descrição e formato de saída. Use essa ferramenta quando: o usuário quer editar um modelo de documento (corpo, nome, descrição ou formato de saída). O corpo é substituído integralmente pelo informado. Antes de usar: consulte get_template com includeDocumentContent para obter o corpo atual, porque o `content` enviado substitui o anterior por inteiro: monte a árvore completa desejada, não só o trecho alterado. O `content` é a árvore do editor, no formato `{"type":"doc","content":[...]}`: os nós aceitos são doc, paragraph, text, heading (níveis 1 a 3), bulletList, orderedList, listItem, table, tableRow, tableCell, tableHeader, hardBreak, horizontalRule, pageBreak e interpolationBlock, e as marcas aceitas são bold, italic, underline, strike, link e textStyle. As variáveis entram no meio do texto entre chaves duplas (`{{card.name}}`); trecho repetido ou condicional vira um nó interpolationBlock com `attrs.kind` igual a `each` ou `if`, `attrs.expression` com a expressão e `attrs.alias` opcional (padrão `item`). Nó, marca ou expressão fora dessa lista é recusado ao salvar, e o corpo aceita no máximo 1 MB. Efeitos colaterais: substitui integralmente o corpo do modelo pela árvore informada e atualiza nome, descrição e formato de saída. As próximas execuções da automação passam a usar a nova versão; documentos já gerados não são alterados retroativamente. Use a ferramenta search com UpdateTemplateDocumentInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:templates:update (pipes).

update_template_document

Altera o nome (título) de um card. O card precisa pertencer à conta autenticada e não estar arquivado, somente leitura ou bloqueado. A alteração é registrada no log de atividades. Use essa ferramenta quando: o usuário quer renomear (alterar o título de) um card. Efeitos colaterais: substitui o nome do card e registra a alteração no log de atividades. Use a ferramenta search com ChangeCardNameInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:cards:update_all (pipes), pipes:cards:update_limited (pipes).

update_card_name

Atualiza o status de uma automação V2 existente. Ao ativar, a automação passa a disparar conforme seu gatilho (precisa ter um gatilho e ações configurados); ao desativar, deixa de disparar até nova ativação; ao arquivar, é considerada removida da operação corrente. Não altera gatilho, condições nem ações. Use essa ferramenta quando: o usuário quer ativar, desativar ou arquivar uma automação V2 existente. Efeitos colaterais: ao ativar, a automação passa a disparar conforme seu gatilho; ao desativar, deixa de disparar até nova ativação; ao arquivar, é considerada removida da operação corrente. Use a ferramenta search com UpdateAutomationV2StatusInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: global:automations_v2:update (global), pipes:automations_v2:update (pipes).

update_automation_status

Edita um modelo de atribuição automática existente. Substitui integralmente a lista de membros pela lista informada, na ordem recebida, e atualiza nome, descrição e modo de distribuição. Trocar o modo não reinicia o revezamento. Use essa ferramenta quando: o usuário quer editar um modelo de atribuição automática (nome, descrição, modo de distribuição ou a lista/ordem de membros). A lista de membros é substituída integralmente pela informada. Antes de usar: a conta precisa ter a flag feature:automatic-assignment ativa (confira com get_account e includeFeatureFlags: true), e incluir um time na lista exige também feature:automatic-assignment-teams e feature:teams; consulte get_template (com includeAssignmentDetails: true) para obter os membros atuais e suas posições, porque members substitui a lista inteira. Efeitos colaterais: substitui integralmente a lista de membros do modelo pela lista informada, na ordem recebida, e regrava nome, descrição e modo de distribuição; atribuições já feitas em cards não são alteradas retroativamente. Use a ferramenta search com UpdateTemplateAssignmentInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:templates:update (pipes).

update_template_assignment

Edita um template de prazo existente. As alterações se refletem nos prazos calculados a partir do template; cards já existentes podem ter o prazo recalculado conforme a nova configuração. Use essa ferramenta quando: o usuário quer editar um template de prazo (nome, descrição, valores de prazo, unidades, horário comercial ou campos). Antes de usar: consulte get_template (com includeFields: true) para obter os valores atuais do template e montar o input apenas com os campos que devem mudar. Efeitos colaterais: as alterações se refletem nos prazos calculados a partir do template; cards já criados podem ter o prazo recalculado conforme a nova configuração. Use a ferramenta search com UpdateTemplateDeadlineInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:templates:update (pipes).

update_template_deadline

Edita um template de relatório existente. Substitui integralmente o conjunto de colunas pela lista informada e atualiza o nome e a descrição. Use essa ferramenta quando: o usuário quer editar um template de relatório (nome, descrição ou lista de colunas). A lista de colunas é substituída integralmente pela informada. Antes de usar: consulte get_template para obter os metadados atuais do template; a atualização substitui integralmente as colunas, então monte o input com a lista completa de colunas desejada (a ordem do array define a posição final no relatório). Efeitos colaterais: substitui integralmente as colunas do template pela lista informada; futuras exportações usarão a nova estrutura. Exportações já concluídas não são alteradas. Use a ferramenta search com UpdateTemplateReportInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:templates:update (pipes).

update_template_report

Edita um template de revisão existente. As alterações se refletem nas próximas aprovações solicitadas pelo template; aprovações já abertas não são alteradas retroativamente. O modelo de prazo e a modalidade do SLA da decisão também são editados aqui: informe deadlineTemplateId (um modelo de prazo do mesmo fluxo, não arquivado e com duração definida) junto de deadlineMode para configurar ou trocar o prazo. Enviar deadlineTemplateId nulo remove o prazo e limpa a modalidade junto, mesmo que deadlineMode também seja enviado. Em aprovação paralela a modalidade é sempre a de prazo único, independentemente do valor enviado. Use essa ferramenta quando: o usuário quer editar um template de aprovação (revisores, tipo, responseType, quantidade mínima de aprovações, campos, modelo de prazo ou modalidade do prazo). Antes de usar: consulte get_template (com includeFields: true e includeReviewDetails: true) para obter os valores atuais do template e montar o input apenas com os campos que devem mudar. Para vincular prazo, consulte list_templates com templateType deadline para obter os modelos de prazo do fluxo. Efeitos colaterais: as alterações se refletem nas próximas aprovações solicitadas pelo template; aprovações já abertas não são alteradas retroativamente. Use a ferramenta search com UpdateTemplateReviewInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:templates:update (pipes).

update_template_review

Edita um template de tarefa existente. As alterações se refletem nas próximas tarefas criadas a partir do template; tarefas já criadas em cards não são alteradas retroativamente. Use essa ferramenta quando: o usuário quer editar um template de tarefa (responsáveis, etiquetas, prioridade, prazo padrão ou campos). Antes de usar: consulte get_template (com includeFields: true e includeTaskDetails: true) para obter os valores atuais do template e montar o input apenas com os campos que devem mudar. Efeitos colaterais: as alterações se refletem nas próximas tarefas criadas a partir do template; tarefas já criadas não são alteradas retroativamente. Use a ferramenta search com EditTemplateTaskInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:templates:update (pipes).

update_template_task

Bloqueia ou desbloqueia um card para edição, conforme o valor de locked. Use essa ferramenta quando: o usuário quer bloquear um card (locked: true) ou desbloqueá-lo (locked: false). Efeitos colaterais: quando locked é true, bloqueia o card impedindo alterações; quando false, desbloqueia o card. Permissões: pipes:cards:lock_unlock (pipes). Dados opcionais (@include): locked (default: false): quando true, executa o bloqueio do card (lockCard) e retorna seu estado bloqueado; quando false, executa o desbloqueio (unlockCard) e retorna o estado liberado.

set_card_locked

Busca documentos da documentação do Flux por texto, ordenados por relevância. Use essa ferramenta quando: o usuário tem uma dúvida sobre uso do produto, telas, configurações ou procedimentos e precisa encontrar páginas relevantes da documentação. Retorna identificador, título, URL e um trecho de cada documento; use get_wiki_document com o identificador para ler o conteúdo completo. Não use quando: quando já se tem o identificador de um documento e se deseja o conteúdo completo, use get_wiki_document. Retorna: id, title, url, excerpt. Argumentos: query: Texto a ser buscado na documentação do Flux.; limit: Número máximo de documentos retornados (entre 1 e 25; padrão 10).

search_wiki_documents

Busca erros do Flux por texto (busca aproximada), ordenados por relevância. Use essa ferramenta quando: o usuário descreve um erro, sintoma ou trecho de mensagem e precisa descobrir o(s) código(s) de erro correspondente(s). Retorna uma lista enxuta (código, mensagem, categoria e caminho da documentação); use get_error com o código para obter os detalhes completos. Não use quando: quando já se tem o código exato do erro, use get_error para obter os metadados completos (incluindo a explicação técnica e os documentos de apoio). Retorna: code, message, docPath, category. Argumentos: query: Texto para busca aproximada de erros (mínimo de 2 caracteres).; limit: Número máximo de resultados retornados (entre 1 e 50; padrão 20).

search_errors

Cria uma nova automação V2 no escopo informado (conta ou fluxo). Cria apenas o registro da automação com nome, descrição e status; o gatilho e as ações precisam ser configurados em seguida via batchUpsertAutomationV2Data. Enquanto não houver um gatilho válido, a automação não dispara mesmo se o status for ativo. Use essa ferramenta quando: o usuário quer criar uma nova automação V2 na conta ou em um fluxo. Efeitos colaterais: cria apenas o registro da automação V2 (nome, descrição, status e fluxo opcional); o gatilho e as ações precisam ser configurados em seguida via batch_upsert_automation_data. Enquanto não houver um gatilho válido, a automação não dispara mesmo se o status for ativo. Use a ferramenta search com CreateAutomationV2Input para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: global:automations_v2:create (global), pipes:automations_v2:create (pipes).

create_automation

Cria um novo comentário em um card. O autor é o usuário autenticado. Cards bloqueados só aceitam comentários quando o fluxo permite (`allow_comments_when_card_locked`). Use essa ferramenta quando: o usuário quer adicionar um comentário em um card para registrar uma observação, atualização ou comunicação. Efeitos colaterais: cria um novo comentário associado ao card e ao usuário autenticado e dispara notificações para os assinantes do card. Use a ferramenta search com CreateCardCommentInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento.

create_card_comment

Cria uma nova etapa. Use essa ferramenta quando: o usuário quer adicionar uma nova etapa a um fluxo existente. Efeitos colaterais: também cria um formulário vazio vinculado à etapa e registra o conjunto inicial de respostas vazio. O índice (ordem) da etapa é definido automaticamente como o último do fluxo. Use a ferramenta search com CreateStageInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:stages:create (pipes).

create_stage

Cria uma nova etiqueta. Use essa ferramenta quando: o usuário quer criar uma nova etiqueta em um fluxo para categorizar cards. Efeitos colaterais: cria a etiqueta e a torna disponível para ser associada a cards e tarefas do fluxo informado. Use a ferramenta search com CreateLabelInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:labels:create (pipes).

create_label

Cria um novo fluxo. Use essa ferramenta quando: o usuário quer criar um novo fluxo na conta. Efeitos colaterais: também cria automaticamente o formulário inicial do fluxo, três etapas padrão (A fazer, Fazendo, Concluído), os cargos padrão do fluxo, e adiciona o usuário autenticado como administrador do fluxo. Use a ferramenta search com CreatePipeInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: global:pipes:create (global).

create_pipe

Cria um novo modelo de documento (template do tipo `document`) no fluxo informado. A estrutura do corpo e cada expressão são validadas no servidor; gerar o arquivo é papel da automação, em operação separada. Use essa ferramenta quando: o usuário quer criar um modelo de documento em um fluxo, escrevendo o corpo com variáveis do card para que uma automação gere depois o arquivo (docx, pdf ou txt). Antes de usar: a conta precisa ter a feature flag `document:templates` ativa (confira com get_account e includeFeatureFlags) e o fluxo precisa estar ativo; consulte list_variables para saber quais variáveis existem. O `content` é a árvore do editor, no formato `{"type":"doc","content":[...]}`: os nós aceitos são doc, paragraph, text, heading (níveis 1 a 3), bulletList, orderedList, listItem, table, tableRow, tableCell, tableHeader, hardBreak, horizontalRule, pageBreak e interpolationBlock, e as marcas aceitas são bold, italic, underline, strike, link e textStyle. As variáveis entram no meio do texto entre chaves duplas (`{{card.name}}`); trecho repetido ou condicional vira um nó interpolationBlock com `attrs.kind` igual a `each` ou `if`, `attrs.expression` com a expressão e `attrs.alias` opcional (padrão `item`). Nó, marca ou expressão fora dessa lista é recusado ao salvar, e o corpo aceita no máximo 1 MB. Efeitos colaterais: cria o modelo de documento no fluxo informado e o disponibiliza para a ação de automação que gera documento a partir de um card. Nenhum arquivo é gerado agora. Use a ferramenta search com CreateTemplateDocumentInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:templates:create (pipes).

create_template_document

Cria um novo modelo de atribuição automática no fluxo informado. O modelo é um subconjunto ordenado de membros do fluxo (pessoas ou times) que as automações usam para escolher quem recebe um card; apontar uma automação para o modelo é uma operação separada. Use essa ferramenta quando: o usuário quer criar um modelo de atribuição automática em um fluxo, com a lista ordenada de membros e a estratégia de distribuição (round_robin reveza na ordem informada, least_loaded escolhe quem tem menos cards abertos). Não use quando: a distribuição deve considerar os membros do fluxo inteiro em vez de um subconjunto: nesse caso não existe modelo, e quem entra no sorteio vem de update_pipe_assignment_settings. Antes de usar: a conta precisa ter a flag feature:automatic-assignment ativa (confira com get_account e includeFeatureFlags: true), e incluir um time na lista exige também feature:automatic-assignment-teams e feature:teams; consulte get_pipe (com includeMembers: true) para obter os membros do fluxo elegíveis, pois a ordem do array members é a ordem de revezamento. Efeitos colaterais: cria o modelo de atribuição no fluxo informado e o disponibiliza para as automações que atribuem responsável automaticamente; nenhum card é atribuído neste momento. Use a ferramenta search com CreateTemplateAssignmentInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:templates:create (pipes).

create_template_assignment

Cria um novo template de prazo no fluxo informado. O template fica disponível para ser vinculado a etapas via attachTemplatesToStage e referenciado em automações; vincular o template a uma etapa é uma operação separada. Use essa ferramenta quando: o usuário quer criar um template de prazo (deadline) em um fluxo para reuso em etapas e automações. Efeitos colaterais: cria o template de prazo no fluxo informado e o disponibiliza para ser vinculado a etapas via attach_templates_to_stage e usado em automações. Use a ferramenta search com CreateTemplateDeadlineInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:templates:create (pipes).

create_template_deadline

Cria um novo template de relatório no fluxo informado. O template define a estrutura de um relatório tabular gerado a partir de um card; sua execução é tratada em operações específicas. Use essa ferramenta quando: o usuário quer criar um template de relatório em um fluxo, definindo colunas e expressões para exportar dados estruturados (xlsx) dos cards. Efeitos colaterais: cria o template de relatório no fluxo informado e o disponibiliza para ser referenciado pela ação em massa pipe_export_template_report ao exportar cards. Use a ferramenta search com CreateTemplateReportInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:templates:create (pipes).

create_template_report

Cria um novo template de revisão (aprovação) no fluxo informado. O template fica disponível para ser vinculado a etapas via attachTemplatesToStage e referenciado em automações; vincular o template a uma etapa é uma operação separada. O modelo de prazo e a modalidade do SLA da decisão são definidos nesta operação: informe deadlineTemplateId (um modelo de prazo do mesmo fluxo, não arquivado e com duração definida) junto de deadlineMode; em aprovação paralela a modalidade é sempre a de prazo único, independentemente do valor enviado. Use essa ferramenta quando: o usuário quer criar um template de aprovação (revisão) em um fluxo, definindo revisores, regras de aprovação e o prazo da decisão. Antes de usar: consulte get_pipe (com includeAssignableUsers: true) para obter os usuários elegíveis como revisores do fluxo. Para vincular prazo, consulte list_templates com templateType deadline para obter os modelos de prazo do fluxo. Efeitos colaterais: cria o template de aprovação no fluxo informado e o disponibiliza para ser vinculado a etapas via attach_templates_to_stage e usado em automações. Use a ferramenta search com CreateTemplateReviewInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:templates:create (pipes).

create_template_review

Cria um novo template de tarefa no fluxo informado. O template fica disponível para ser vinculado a etapas via attachTemplatesToStage e referenciado em automações; vincular o template a uma etapa é uma operação separada. Use essa ferramenta quando: o usuário quer criar um template de tarefa em um fluxo, com responsáveis, etiquetas, prioridade e prazo padrão. Efeitos colaterais: cria o template de tarefa no fluxo informado e o disponibiliza para ser vinculado a etapas via attach_templates_to_stage e usado em automações. Use a ferramenta search com CreateTemplateTaskInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:templates:create (pipes).

create_template_task

Desvincula um template de uma etapa. Remove apenas a associação entre o template e a etapa; o template continua existindo no fluxo e pode ser revinculado posteriormente via attach_templates_to_stage. Para arquivar o template em si, use set_template_archived. Use essa ferramenta quando: o usuário quer desvincular um template de uma etapa sem arquivar o template. Antes de usar: consulte list_templates_by_stage para confirmar que o template está realmente vinculado à etapa. Efeitos colaterais: remove apenas o vínculo entre o template e a etapa; o template continua existindo no fluxo e pode ser revinculado posteriormente via attach_templates_to_stage. Argumentos: stageId: Etapa da qual o template será desvinculado.; templateId: Template a ser desvinculado da etapa.

detach_template_from_stage

Remove uma etiqueta. Use essa ferramenta quando: o usuário quer excluir permanentemente uma etiqueta de um fluxo. Efeitos colaterais: exclusão permanente (hard delete): remove também todas as associações da etiqueta com cards (cardLabel) e com tarefas de cards (cardTaskLabel) da conta. Não pode ser desfeita. Use a ferramenta search com DeleteLabelInput para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: pipes:labels:delete (pipes).

delete_label

Gera a documentação completa de um fluxo em Markdown. Use essa ferramenta quando: o usuário precisa gerar a documentação completa de um fluxo. Não use quando: o fluxo já tem documentação escrita e a pergunta é sobre como o processo funciona — nesse caso use get_pipe_generated_documentation. Esta ferramenta monta um retrato da configuração atual na hora, não a descrição do processo. Retorna: markdown. Permissões: global:pipes:read_all (global), global:pipes:read_limited (global).

generate_pipe_documentation

Substitui em lote o gatilho, suas condições e a lista de ações de uma automação V2. Operação destrutiva por substituição: itens existentes (gatilho, condições e ações) que não forem incluídos no input são excluídos; itens com id informado são atualizados; itens sem id são criados com um id gerado. Afeta o disparo a partir das próximas execuções e não altera execuções já registradas. Use essa ferramenta quando: o usuário quer configurar de uma só vez o gatilho, suas condições e a lista completa de ações de uma automação V2 (criar pela primeira vez ou substituir os existentes). Antes de usar: consulte get_automation (com includeTrigger: true e includeActions: true) para entender a configuração atual; consulte list_automation_metadata para conhecer os tipos de gatilho e ação disponíveis e o formato esperado de properties (e includeContext para variáveis de contexto). Efeitos colaterais: operação destrutiva por substituição: itens (trigger, condições e ações) existentes que não forem incluídos no input são excluídos; itens com id informado são atualizados; itens sem id são criados. Limite de 1 trigger, 100 condições e 10 ações por automação. Afeta o disparo a partir das próximas execuções (não altera execuções já registradas). Use a ferramenta search com BatchUpsertAutomationV2Input para obter a estrutura completa do(s) input(s), incluindo tipos aninhados, antes de montar o argumento. Permissões: global:automations_v2:manage_actions (global), global:automations_v2:manage_triggers (global), pipes:automations_v2:manage_actions (pipes), pipes:automations_v2:manage_triggers (pipes).

batch_upsert_automation_data

Recupera uma lista paginada de automações. Use essa ferramenta quando: o usuário quer listar todas as automações de um fluxo ou da conta. Retorna resultados paginados com: id, name, status, createdAt. Suporta paginação (skip/take), filtros (PaginatedAutomationV2Filters), ordenação. Permissões: global:automations_v2:read (global), pipes:automations_v2:read (pipes). Dados opcionais (@include): includeDescription (default: false): Traz a descrição da automação; includeTimestamps (default: false): Traz a data de última atualização (updatedAt) da automação; includePipe (default: false): Traz o fluxo ao qual a automação pertence (id e nome); includeCreatedBy (default: false): Traz o usuário que criou a automação (id e nome).

list_automations