Delete Organization Report

Before You Begin

🔗 Use the GraphQL Playground to execute the mutations in this guide.

➡️ New to GraphQL? Learn how to navigate the Playground with our Playground Basics Guide.

Prerequisites

1. Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
2. Permissions: Ensure your token has the necessary permissions to delete the specific report.
3. Report ID: Identify the Organization Report you want to delete.

Step 1: Find The Report ID

1. Via Pipefy UI:

   1. Open the Organization Report in your browser.
   2. The URL will include the Report ID: https://app.pipefy.com/organizations/123/reports/987654321.
   3. Report ID = 987654321 (the number after /reports/).

2. Via GraphQL Query:

   1. Use the organizationReports query to list all reports and find the specific report ID you need.
   2. How to get organization reports.

Step 2: Delete Organization Report

Execute the deleteOrganizationReport mutation:

mutation {
  deleteOrganizationReport(input: { id: 456789123 }) {
    success
  }
}

Response Example

{
  "data": {
    "deleteOrganizationReport": {
      "success": true
    }
  }
}

Arguments Explained

Required Arguments

• id: ID - The report ID to delete

Verification

After deletion, you can verify the report no longer exists by querying it:

{
  organizationReport(id: 456789123) {
    id
    name
  }
}

Expected Response (Report Deleted)

{
  "data": {
    "organizationReport": null
  }
}