Instantly icon

Instantly

Interact with Instantly API

Unibox → Get Many Unibox Messages

AI-generated

Overview

This node operation retrieves multiple Unibox messages from the Instantly API based on various filters and parameters. It is useful for scenarios where users want to fetch email messages from their Unibox inbox with specific criteria such as unread status, campaign ID, email account, message mode, and more. For example, a user can fetch all unread messages related to a particular campaign or retrieve a limited number of sent messages sorted in descending order.

Use Case Examples

  1. Fetch all unread Unibox messages for a specific campaign.
  2. Retrieve up to 50 sent messages filtered by email account and sorted ascendingly.
  3. Get all Unibox messages that have reminders and belong to the 'Focused' mode.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of results to return when 'Return All' is false.
Search Search term to filter Unibox messages.
Campaign ID Filter messages by campaign ID.
Email Account Filter messages by email account (sender or receiver).
Is Unread Filter messages by unread status.
Has Reminder Filter messages that have reminders.
Mode Filter Unibox messages by mode (Focused, Others, or All).
Email Type Type of messages to retrieve (Received, Sent, or Manual).
Lead Email Filter messages by lead email address.
Sort Order Sort order for the results (Ascending or Descending).

Output

JSON

  • id - Unique identifier of the Unibox message.
  • subject - Subject line of the message.
  • from - Sender email address.
  • to - Recipient email address.
  • date - Date and time when the message was sent or received.
  • isUnread - Boolean indicating if the message is unread.
  • hasReminder - Boolean indicating if the message has a reminder set.
  • mode - Mode of the message (Focused, Others, or All).
  • emailType - Type of the email message (Received, Sent, or Manual).
  • campaignId - ID of the campaign associated with the message.
  • leadEmail - Email address of the lead associated with the message.

Dependencies

  • Instantly API with API key credential

Troubleshooting

  • Common issues include API request failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
  • Errors may occur if filter parameters are invalid or improperly formatted; verify input values especially for IDs and email addresses.
  • If no messages are returned, check that the filters are not too restrictive or that there are messages matching the criteria in the Unibox inbox.

Discussion