Unipile icon

Unipile

Interact with Unipile API

Overview

This node integrates with the Unipile API to send emails. Specifically, the "Send Email" operation under the "Email" resource allows users to send an email by providing a raw JSON body that defines the email content and parameters. This node is useful in automation workflows where programmatic email sending is required, such as sending notifications, alerts, or transactional emails based on triggers or other workflow data.

Practical examples include:

  • Sending a notification email when a new item is created in a CRM.
  • Dispatching automated reports or summaries via email.
  • Triggering alert emails based on monitoring or event conditions.

Properties

Name Meaning
Body (JSON) Raw JSON object representing the email content and parameters to be sent via the API.

The "Body (JSON)" property expects a JSON structure that conforms to the Unipile API's email sending format. Users must provide all necessary fields such as recipients, subject, message body, etc., within this JSON.

Output

The node outputs the response from the Unipile API after attempting to send the email. The output is structured as JSON data containing details about the success or failure of the email sending operation, including any metadata or identifiers returned by the API.

If the API supports binary attachments or similar features, those would be handled within the JSON response or through additional output fields, but this is not explicitly detailed in the provided code.

Dependencies

  • Requires an active connection to the Unipile API.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The base URL for the API is dynamically set from the credential configuration.
  • The node sends HTTP requests with JSON payloads and expects JSON responses.

Troubleshooting

  • Invalid JSON Body: If the JSON provided in the "Body (JSON)" property is malformed or missing required fields, the API will likely return an error. Ensure the JSON is valid and matches the expected schema.
  • Authentication Errors: Missing or incorrect API credentials will cause authorization failures. Verify that the API key/token is correctly configured.
  • API Endpoint Issues: If the base URL or endpoint paths are misconfigured, requests may fail. Confirm the credential DSN and request URLs.
  • Network Issues: Connectivity problems can prevent the node from reaching the Unipile API.
  • Error Messages: The node will typically relay error messages from the API response. Review these messages to identify issues such as invalid parameters or quota limits.

Links and References

Discussion