Plain icon

Plain

Interact with Plain API

Label → Remove

AI-generated

Overview

This node interacts with the Plain API to manage labels among other resources. Specifically, for the Label - Remove operation, it removes a label from the system by its unique label ID. This is useful in scenarios where you want to programmatically delete or clean up labels that are no longer needed or were created by mistake.

Practical example:

  • Automatically removing outdated or irrelevant labels from threads or entities in your workflow to keep data organized and relevant.

Properties

Name Meaning
Label ID The unique identifier of the label to remove (not the label type ID).

Output

The output JSON contains a single field indicating success:

{
  "success": true
}

This confirms that the label removal was successful. If an error occurs, the node throws an error message describing the failure.

Dependencies

  • Requires an authenticated connection to the Plain API via an API key credential.
  • The node uses GraphQL mutations to communicate with the Plain API.
  • No additional environment variables are required beyond the API authentication setup.

Troubleshooting

  • Common issues:
    • Providing an invalid or non-existent Label ID will cause the mutation to fail.
    • Network or authentication errors can prevent the API call from succeeding.
  • Error messages:
    • If the label ID is missing or incorrect, the node will throw an error with the message returned by the Plain API.
    • Authentication failures will result in errors indicating invalid credentials or permission denied.
  • Resolution:
    • Ensure the Label ID is correct and exists in the Plain system.
    • Verify that the API key credential is valid and has sufficient permissions.
    • Check network connectivity to the Plain API endpoint.

Links and References


This summary focuses exclusively on the Label resource's Remove operation as requested.

Discussion