Como atualizar cards em massa via API

🔐 Disponível para todos os planos

🎯 Para quem quer atualizar informações de cards em massa

⏩ Resumo:

Aprenda a tirar o máximo proveito da API do Pipefy para realizar consultas e ações para atualizar cards em massa:

Crie relatórios no pipe para extrair os IDs dos cards a serem atualizados;
Utilize queries na API para identificar os IDs dos campos que deseja atualizar;
Use mutations para atualizar os valores dos campos indicados;
Atente-se ao volume de chamadas de API disponíveis em seu plano.

Como atualizar cards em massa

É possível atualizar cards em massa utilizando a API do Pipefy (GraphiQL). Na API, é possível realizar consultas (queries) e ações (mutations) em seus processos. Saiba mais sobre como usar a API do Pipefy.

📢 Atenção: Para que você possa utilizar a API, você precisa ter a função de administrador na empresa. Saiba mais sobre funções e permissões no Pipefy.

Apesar de ser necessário um pouco de código, neste artigo você encontrará todos os passos necessários para que você faça as atualizações.

Passos para atualizar cards em massa

Você vai precisar realizar algumas ações dentro do pipe que deseja atualizar os cards e depois na API do Pipefy.

🎥 Se preferir, veja esse vídeo gravado pelo nosso time de Suporte:

Dentro do pipe que deseja atualizar cards

Para começar, você precisará do ID do pipe que quer atualizar os cards em massa. Acessando o pipe, você encontrará o ID na URL.

Você precisará dos IDs dos cards a serem atualizados. Para não precisar acessar um a um, basta criar um Relatório com o parâmetro definido e exportar o arquivo CSV.

Um novo relatório será criado com parâmetros predeterminados.

Clique no seletor de colunas para adicionar o código (ID) dos cards.

Exporte seu relatório para utilizar os IDs na construção da mutation. Saiba mais sobre como utilizar relatórios de pipes.

💡 Dica: Você pode salvar seu relatório para utilizar sempre que necessário, economizando tempo e trabalho quando precisar atualizar mais cards ou consultar outras informações do seu processo.

Na API do Pipefy

Agora que você já tem o ID do pipe e dos cards que quer atualizar, você vai precisar realizar uma query para identificar os IDs dos campos que quer atualizar.

📢 Atenção: Recomendamos que teste um card antes de adicionar outros, assim você pode consultar os resultados e garantir que não terá problemas ao atualizar mais cards em massa. Sugerimos que faça as alterações em levas de até 30 cards, assim você evita o bloqueio do seu IP.

Acesse a API e siga as instruções abaixo:

Na parte esquerda da tela, você precisará colar a seguinte query, substituindo o ID do pipe pelo código que identificou no primeiro passo, dentro do pipe.

query{
  pipe(id:ID do pipe){
    start_form_fields{
      id
      label
    }
    phases{
      name
      fields{
       id
       label
      }
    }
  }
}

A query deverá estar parecida com esta:

Clique no botão para rodar a query e retornar os IDs dos campos.
No lado direito, você terá a lista com as informações solicitadas:
- Os campos do formulário inicial com os IDs e o títulos deles;
- Os campos das fases com os IDs e títulos deles.
Você precisará do ID do campo que quer atualizar, então procure na lista o valor necessário. Vamos supor que queremos atualizar os valores no campo Recrutador.
O ID do campo Recrutador, na fase Triagem, é recrutador.

Com as informações que você tem em mãos, você pode construir a mutation a seguir alterando as informações.

mutation{
n1 : updateCardField(input:{card_id: 123456 field_id: "my_text_field" new_value: "New value text" })
n2 : updateCardField(input:{card_id: 789101 field_id: "my_text_field" new_value: "New value text" })
n3 : updateCardField(input:{card_id: 234567 field_id: "my_text_field" new_value: "New value text" })
n4 : updateCardField(input:{card_id: 765432 field_id: "my_text_field" new_value: "New value text" })
n5 : updateCardField(input:{card_id: 543210 field_id: "my_text_field" new_value: "New value text" })
}

A mutation deverá estar parecida com esta:

Cada linha (nx) representa um card diferente. Adicione até 30 linhas, alterando os valores respectivos a cada um dos cards, sempre mantendo a chave ( } ) ao final.

Em cada linha, você deve informar o ID do card específico, o ID do campo a ser alterado e o novo valor.
Quando tiver atualizado todas as informações na mutação, clique para rodar as alterações.
No lado direito, você terá o retorno sobre o sucesso de cada card (nx). Caso retorno como “success”: true, quer dizer que funcionou.

📢 Atenção: Atente-se ao rodar atualizações ou consultas em massa, uma vez que as chamadas de API consomem parte dos limites do seu plano. Saiba mais sobre os limites dos planos.

Conteúdos relacionados

🎓 Aprenda a fazer muito mais com os cursos gratuitos da Pipefy Academy!

🌎 Faça parte da Comunidade do Pipefy para tirar dúvidas, compartilhar sugestões, ficar por dentro das novidades e dividir seu conhecimento com pessoas do mundo todo!