⏩ Content Summary:
Learn how to make the most of Pipefy’s API to add many members at once:
Identify your pipe ID.
Use mutations to add pipe members with different permissions.
Perform the above actions without exceeding your plan's allowable volume.
How to add members in mass
You can add members in mass using Pipefy’s API (GraphiQL) to make queries and mutations (actions) in your processes. Learn how to use Pipefy’s API.
📢 Keep in mind: To be able to use the API, you have to have administrator permissions in your organization. Learn more about roles and permissions in Pipefy.
You’ll be doing a bit of coding here, but this article includes all the necessary steps to make these updates.
Inside the pipe you want to add members
To start, you will need the ID of the pipe you want to add members in mass. Open the pipe. The ID is located in the URL:
In Pipefy’s API
Now that you have the ID of the pipe, you will need to make a mutation to add the members to your pipe.
📢 Keep in mind: We recommend you test one addition before adding others; it’s best to confirm results before adding members in mass. When ready to make mass updates, we suggest you change no more than 30 members each time to prevent the system from blocking your ID.
Access the API and follow the instructions below.
At the left side of the screen, paste the following mutation, replacing the pipe ID (found in the last step), the email of the user to be invited, and the permission level.
💡 Tip: for the permission level, use admin for pipe admin; member for pipe member; read_and_comment for restricted view; my_cards_only for read only and creator for start form only
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
}
}
The mutation must look like this:
After running the mutation, on the right side, you will see the confirmation message like this:
📢 Keep in mind: Be careful when making updating in mass, as it’s possible for the API to exceed your plan’s volume. Learn more about plan limits.
Related content
🎓 Learn how to do more with less with free Pipefy Academy courses!
🌎 Join the Pipefy Community to ask questions, share ideas, stay tuned for product updates and events, and showcase your knowledge with professionals from around the globe!