Pipefy icon

Pipefy

Interact with Pipefy API

Actions32

Overview

This node interacts with the Pipefy API to update an existing table within a Pipefy organization. It allows users to modify the table's name, description, and its fields. This operation is useful when you need to rename a table, update its description for clarity, or change the structure of the table by adding, removing, or modifying fields.

Practical examples:

  • Renaming a project tracking table to better reflect its purpose.
  • Updating the description of a table to provide more context to team members.
  • Changing the fields in a table to accommodate new data requirements without recreating the table.

Properties

Name Meaning
Table ID The unique identifier of the table to update.
Name The new name to assign to the table.
Description (Optional) A new description for the table to provide additional details or context.

Output

The output JSON contains the updated table object with the following structure:

  • id: The unique identifier of the table.
  • name: The updated name of the table.
  • description: The updated description of the table.
  • fields: An array of field objects, each containing:
    • label: The label/name of the field.
    • type: The type of the field (e.g., short_text, number, date).
    • required: Boolean indicating if the field is required.
    • help: Help text associated with the field.
    • description: Additional description of the field.

Example output snippet:

{
  "id": "123",
  "name": "Updated Table Name",
  "description": "Updated description",
  "fields": [
    {
      "label": "Priority",
      "type": "select",
      "required": true,
      "help": "Select priority level",
      "description": "Defines task priority"
    }
  ]
}

No binary data is involved in this operation.

Dependencies

  • Requires an active connection to the Pipefy API via an API key credential.
  • The node sends GraphQL requests to the Pipefy API endpoint at https://api.pipefy.com/graphql.
  • Proper permissions on the Pipefy account to update tables are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Table ID: Ensure the Table ID provided exists and is correct.
    • Insufficient permissions: The API key used must have rights to update tables.
    • Malformed field definitions: Fields must be correctly structured; otherwise, the API may reject the request.
  • Error messages:

    • "Field 'id' is required": Occurs if Table ID is not provided.
    • "Unauthorized" or "Forbidden": Indicates API key lacks permission.
    • "Invalid input": Usually due to incorrect field formatting or invalid values.
  • Resolutions:

    • Double-check all required parameters are set.
    • Verify API credentials and permissions.
    • Validate the structure and content of fields before sending.

Links and References

Discussion