Mindz icon

Mindz

Interact with Mindz API

Actions115

Overview

The node interacts with the Mindz API to manage email campaign plans. Specifically, the "Get" operation for the "Email Campaign Plan" resource retrieves detailed information about a specific plan associated with an email campaign. This is useful when you want to fetch configuration or status details of a particular email campaign plan within your marketing automation workflows.

Practical examples include:

  • Retrieving the settings of a specific email campaign plan before updating or analyzing it.
  • Fetching plan details to display in dashboards or reports.
  • Using the plan data to trigger conditional logic in automated workflows.

Properties

Name Meaning
Email Campaign ID The unique identifier of the email campaign to which the plan belongs.
Plan ID The unique identifier of the specific plan within the email campaign to retrieve details.

Output

The output JSON contains the detailed information of the requested email campaign plan. This typically includes all relevant fields describing the plan's configuration, status, and metadata as returned by the Mindz API.

If the node supports binary data output (not indicated here), it would represent any file or media content related to the plan, but this operation primarily returns structured JSON data.

Dependencies

  • Requires an active connection to the Mindz API via an OAuth2-based API key credential.
  • The node depends on proper configuration of the Mindz API credentials within n8n.
  • Network access to the Mindz API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Email Campaign ID or Plan ID will cause the API call to fail.
    • Authentication errors if the API key credential is not set up correctly or has expired.
    • Network connectivity problems can prevent successful API communication.
  • Error messages:

    • "Resource not found" or similar indicates that either the Email Campaign ID or Plan ID does not exist or is incorrect.
    • "Authentication failed" suggests issues with the API credentials; verify and refresh them.
    • "Request timeout" or network errors require checking internet connectivity and API availability.

Resolving these usually involves verifying input parameters, ensuring valid credentials, and confirming network access.

Links and References

  • Mindz API Documentation (general reference for endpoints and data structures)
  • n8n OAuth2 Credential Setup Guide (for configuring API authentication)

Discussion