Delete SMTP Configuration

Before You Begin

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

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

Why this use case

Teams managing outbound email sometimes need to remove an SMTP configuration that is no longer in use — for example, after migrating to a new provider or decommissioning a relay. This use case shows how to delete an SMTP configuration using the Pipefy GraphQL API.

Prerequisites

Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
Permissions: Your token must have Admin (manage) access to SMTP configurations for the organization. Users without manage access receive a permission error.
SMTP Configuration ID: Identify the configuration you want to delete — see List SMTP Configurations to retrieve existing IDs.

Step 1: Delete the configuration

Provide the id of the configuration to remove.

Operation

mutation DeleteSmtpConfig($input: DeleteSmtpConfigurationInput!) {
  deleteSmtpConfiguration(input: $input) {
    success
  }
}

Arguments (input)

id: ID — Required — the ID of the SMTP configuration to delete.

Example (realistic values)

{
  "input": {
    "id": "060f4d01-b412-43e0-999c-73e4f36889a9"
  }
}

Expected response

{
  "data": {
    "deleteSmtpConfiguration": {
      "success": true
    }
  }
}

Key notes

A successful deletion returns success: true.
Deleting a configuration you do not have manage access to returns a permission error.
Requesting an id that does not exist returns a not-found error.
To create a configuration, see Create SMTP Configuration. To change one, see Update SMTP Configuration.