Como atualizar etiquetas via API
Douglas Aliot avatar
Escrito por Douglas Aliot
Atualizado há mais de uma semana

🔐 Disponível para todos os planos

🎯 Para quem quer atualizar etiquetas em massa

⏩ Resumo:

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

  • Identifique o ID do seu Pipe;

  • Utilize queries na API para identificar as etiquetas que deseja atualizar;

  • Use mutations para atualizar campos de etiqueta;

  • Atente-se ao volume de chamadas de API disponíveis em seu plano.

Como atualizar etiquetas em massa

É possível atualiza-las 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.

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

Dentro do pipe que deseja atualizar etiquetas

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

Você também precisará do ID do card que contém as etiquetas a serem atualizadas. Abra o card. O ID está localizado no final da URL.

Na API do Pipefy

Agora que você já tem o ID do pipe e dos cards que quer atualizar, você vai precisar realizar duas queries para identificar os IDs do campo de etiqueta e do nome da etiqueta.

📢 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 primeira query, substituindo o ID do pipe pelo código que identificou no primeiro passo, para encontrar o ID do campo de etiqueta.

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

A query deverá estar parecida com esta:

No lado direito, você terá a lista com as informações solicitadas. Encontre o campo de etiqueta do seu pipe:

Agora, você precisará colar a segunda query, substituindo o ID do pipe, para encontrar o ID do nome da etiqueta.

{
pipe(id:Id do Pipe)
{
labels
{
id
name
}
}
}

A query deverá estar parecida com esta. Agora temos o ID do nome da etiqueta

Com as informações que você tem em mãos, você pode construir a mutation a seguir alterando as informações.
Para atualizar a etiqueta, substitua o card_id, field_id, e new_value com ID do card, ID do campo de etiqueta, e ID do nome da etiqueta, respectivamente.


mutation{
n1 : updateCardField(input:{card_id: ID do card field_id: "ID do campo de etiqueta" new_value: "ID do nome da etiqueta"}) {
clientMutationId
}
}

Após rodar a mutation no GraphiQL, esse será o resultado:

📢 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!


Respondeu à sua pergunta?