Referral Factory icon

Referral Factory

Get data from Referral Factory API

Overview

The "Qualify a User" operation in the Referral Factory node allows users to determine the qualification status of a user based on specific criteria. This is particularly useful for marketing and referral programs where understanding user engagement or eligibility can drive targeted campaigns. Common scenarios include qualifying users by their email address, referral code, or coupon, enabling businesses to tailor their outreach and incentives effectively. For example, a company might use this feature to verify if a user who signed up with a specific coupon is eligible for a promotional offer.

Properties

Name Meaning
Qualify By ... The method used to qualify the user. Options include:
- by_email_address
- by_referral_code
- by_coupon
Campaign Name or ID The campaign associated with the qualification process. Users can select from a list or specify an ID using an expression.
Email The email address of the user being qualified (required when qualifying by email address).
Referral Code The referral code used to qualify the user (required when qualifying by referral code).
Coupon The coupon used to qualify the user (required when qualifying by coupon).

Output

The output of the "Qualify a User" operation will typically be structured as JSON, containing information about the user's qualification status and any relevant details returned from the API. The exact structure may vary depending on the API response but generally includes fields indicating whether the user is qualified and additional data related to the qualification criteria used.

If the node can output binary data, it would likely represent files or documents related to the user's qualification status, though specifics are not detailed in the provided source.

Dependencies

  • An API key credential is required to authenticate requests to the Referral Factory API.
  • The node relies on the Referral Factory API endpoint at https://referral-factory.com/api/n8n for processing qualification requests.
  • Users must ensure that they have access to the necessary campaigns within the Referral Factory system.

Troubleshooting

  • Common Issues:

    • Users may encounter issues if the specified campaign ID does not exist or is incorrectly formatted.
    • If the email, referral code, or coupon is invalid or not recognized, the API may return an error indicating that the qualification failed.
  • Error Messages:

    • "Invalid campaign ID": Ensure that the campaign ID is correct and exists in the Referral Factory system.
    • "User not qualified": Check the input parameters to confirm they meet the qualification criteria set by the API.

Links and References

Discussion