How to clear fields in bulk via API

🔐 Available on all plans

🎯 For those who want to update fields' information in mass

⏩ Content Summary:

Learn how to make the most of Pipefy’s API to clear many fields at once:

Identify your Pipe ID.
Use queries in the API to identify the fields’ IDs you want to clear.
Use mutations to clear values in the indicated fields.
Perform the above actions without exceeding your plan's allowable volume.

How to clear fields in mass

You can clear fields 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.

First, find the pipe containing the cards to be updated; you will need to perform a few actions in it. You will also need to open Pipefy’s API.

Inside the pipe containing cards to be updated

To start, you will need the ID of the pipe containing the fields you want to clear in mass.

Open the pipe. The ID is located in the URL:

You will also need the ID of the card containing the fields you want to clear.

Open the card. The ID is located in the end of the URL:

In Pipefy’s API

Now that you have the ID of the pipe and of the cards you want to update, you will need to make a query to identify the fields’ IDs you want to update.

📢 Keep in mind: We recommend you test one card before adding others; it’s best to confirm results before updating cards in mass. When ready to make mass updates, we suggest you change no more than 30 cards 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 in the following query, replacing the pipe’s ID (the code you identified in the first step) inside the pipe.

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

The query will look like this:

On the right side, you will have a list with the information requested:

Start form fields with their IDs, labels, and Internal_id.
Phase fields with their IDs, labels, and Internal_id.

You will need the ID of the field you want to update, so search for the value in the list. For example, let’s suppose we need to update the values in the Requester name field.

The ID of the field Requester name in the Start form is requester_name.

With the information you now have, you can build a mutation by altering the following information.
To clear the fields, the information in new_value must be double quotes ("")

mutation{
  updateCardField(input:{
    card_id: Card ID
    field_id:"Field ID"
    new_value:""
  })
}

After running the query in GraphiQL, it will look 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!