N8N Tools - Yup.chat icon

N8N Tools - Yup.chat

Send messages and manage communications through Yup.chat
Join our community

Actions17

Overview

This node integrates with the Yup.chat API to manage contacts and messaging across multiple communication channels such as SMS, WhatsApp, RCS, and Omni Rooms. Specifically, for the Contacts - Get Many operation, it retrieves a list of contacts from the Yup.chat platform. This is useful when you want to fetch contact data in bulk for further processing, reporting, or integration with other systems.

Common scenarios include:

  • Synchronizing contact lists from Yup.chat into a CRM or database.
  • Filtering contacts based on specific criteria (e.g., creation date).
  • Retrieving all contacts or limiting the number of contacts fetched for performance reasons.

Example: Fetching all contacts created after January 1, 2023, to update a marketing campaign audience.

Properties

Name Meaning
Return All Whether to return all contacts or only up to a specified limit.
Limit Maximum number of contacts to return if "Return All" is false. Range: 1 to 500.
Filters Filter parameters as a string to narrow down the contacts returned (e.g., filter=created_at:2023-01-01).

Output

The output is an array of JSON objects representing contacts retrieved from Yup.chat. Each object corresponds to a single contact with its associated properties as provided by the Yup.chat API.

  • If multiple contacts are returned, each contact is output as a separate item.
  • The structure of each contact object depends on the Yup.chat API response but typically includes identifiers, contact details, and metadata.
  • No binary data is output by this operation.

Dependencies

  • Requires an API key credential for Yup.chat to authenticate requests.
  • The base URL for the Yup.chat API defaults to https://api.yup.chat but can be overridden via credentials.
  • The node uses HTTP requests to communicate with the Yup.chat REST API.

Troubleshooting

  • Common issues:

    • Invalid or missing API key will cause authentication errors.
    • Incorrect filter syntax may result in no results or API errors.
    • Requesting too many contacts without pagination or limits might lead to timeouts or rate limiting.

  • Error messages:

    • Authentication failures: Check that the API key credential is correctly configured.
    • HTTP request errors: Verify network connectivity and API endpoint availability.
    • Parsing errors on filters: Ensure filter strings follow Yup.chat API specifications.

  • To resolve errors, verify credentials, review filter syntax, and adjust limits or enable "Return All" carefully.

Links and References

Discussion