Plain icon

Plain

Interact with Plain API

Label → Add

AI-generated

Overview

The node interacts with the Plain API to manage various resources including companies, customers, threads, events, labels, and tenants. Specifically for the Label resource with the Add operation, it adds a label of a specified type to a given thread.

This is useful in scenarios where you want to programmatically tag or categorize threads (e.g., support tickets, conversations) within the Plain system by adding labels that help organize or filter them later.

Example use case: Automatically add a "High Priority" label to a customer support thread when certain conditions are met, enabling easier tracking and prioritization.

Properties

Name Meaning
Thread ID The unique identifier of the thread to which the label will be added.
Label Type ID The unique identifier of the label type to add to the thread.

Output

The output JSON contains an array of label objects that were added to the thread. Each label object includes:

  • id: The unique identifier of the label.
  • labelType: An object containing:
    • id: The unique identifier of the label type.
    • name: The name of the label type.

If the operation fails, an error message is thrown.

Dependencies

  • Requires an API key credential for authenticating with the Plain API.
  • Uses GraphQL queries/mutations to interact with the Plain API.
  • The node expects the environment to have network access to the Plain API endpoint configured in the credentials.

Troubleshooting

  • Error: "Unknown error" or specific error messages from the API
    This usually indicates an issue with the provided IDs or API permissions. Verify that the Thread ID and Label Type ID are correct and that the API key has sufficient rights.

  • Error related to missing parameters
    Ensure both Thread ID and Label Type ID are provided and non-empty.

  • API rate limits or connectivity issues
    Check network connectivity and API usage limits.

Links and References


This summary focuses exclusively on the Label resource with the Add operation as requested.

Discussion