Todas as coleções
APIs, Segurança e Gestão de TI
APIs
Como convidar pessoas em massa para um pipe via API
Como convidar pessoas em massa para um pipe via API
Douglas Aliot avatar
Escrito por Douglas Aliot
Atualizado há mais de uma semana

🔐 Disponível para todos os planos

🎯 Para quem quer adicionar pessoas em massa a um pipe

⏩ Resumo:

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

  • Identifique o ID do pipe;

  • Use mutations para adicionar os membros em massa;

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

Como adicionar pessoas em massa

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

Dentro do pipe que deseja adicionar pessoas

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

Na API do Pipefy

Agora que você já tem o ID do pipe, você vai precisar realizar uma mutation para adicionar os usuários em massa.

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

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

No lado esquerdo da tela, copie a seguinte mutation, substituindo o ID do pipe (encontrado no último passo), o email do usuário que será convidado e o nível de permissão.

💡 Dica: para o nível de permissão, utilize admin para admin do pipe; member para membro do pipe; read_and_comment para visão restrita; my_cards_only para somente leitura e creator para apenas formulário inicial.

mutation {
n1: inviteMembers(input: {pipe_id: pipe ID, emails: { email: "email@email.com", role_name: "permission level"}}){
clientMutationId
n2: inviteMembers(input: {pipe_id: pipe ID, emails: { email: "email@email.com", role_name: "permission level"}}){
clientMutationId
n3: inviteMembers(input: {pipe_id: pipe ID, emails: { email: "email@email.com", role_name: "permission level"}}){
clientMutationId
}
}

A mutation deverá estar parecida com esta:

Após executar a mutation, do lado direito da tela, você verá a mensagem de confirmação parecida com essa:

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