FirstPromoter icon

FirstPromoter

Interact with the official FirstPromoter APIs

Referral → Update Referral

AI-generated

Summary

Update a referral's details in FirstPromoter by locating it using one of the specified attributes (ID, UID, Email, or Username) and modifying campaign association and optional split details.

Inputs

  • Find by Attribute (required) — Choose the attribute to find the referral by: Email, ID, UID, or Username.
  • Attribute Value (required) — The value of the chosen attribute to locate the referral, e.g., the referral's ID, UID, email, or username.
  • Promoter Campaign ID — The Promoter Campaign ID to assign to the referral. This ID links the promoter to a campaign and is not the campaign ID itself.
  • Split Details Percentage — Optional percentage (0 to 100) defining the split value. This feature requires prior enablement via support.
  • Promoter Campaign ID to Split Details For — Optional Promoter Campaign ID to specify which campaign the split applies to. This requires prior enablement via support.

Output shape

a single record in JSON format representing the updated referral data returned by the FirstPromoter API.

Returns the updated referral object from FirstPromoter. The operation uses a PUT HTTP request. If the referral can't be found or an error occurs, an error message will be returned or thrown depending on the node settings.

Links

Discussion