PERS icon

PERS

Interact with the PERS Loyalty API

Actions14

Campaign Claim → Claim Campaign

AI-generated

Summary

Submits a campaign reward claim for a user to the PERS Loyalty API (POST /campaigns/claims), identifying the campaign via a trigger source ID and returning the API's response.

Inputs

  • Trigger Source ID — Preferred identifier for trigger-specific claims (QR code, NFC tag, geofence, etc.). Takes precedence over Campaign ID.
  • User Identifier (required) — Email or external ID of the user making the claim.
  • Additional Fields: Campaign ID (Deprecated) — Legacy campaign identifier; ignored in favor of Trigger Source ID if both are set. Slated for removal in Q2 2026.
  • Additional Fields: Business ID (Deprecated) — Legacy business context for the claim. Slated for removal in Q2 2026.
  • Additional Fields: External Reference ID — Idempotency key (e.g. Stripe payment ID, order ID). The request is rejected if a claim with this ID already exists.
  • Additional Fields: Latitude / Longitude — User location for geo validation. Required when the campaign trigger has a max geo distance configured.
  • Additional Fields: Metadata — JSON object of campaign metadata attached to the claim.
  • Additional Fields: Multiplier — Multiplier applied to the reward amount (reward × multiplier). Defaults to 1.
  • Additional Fields: User Info — JSON of user details (email, phoneNumber, firstName, etc.). Only needed if the trigger requires user info and the profile doesn't already store it.

Output shape

One output item per input item, containing the JSON response from the PERS API for the claim.

The response schema isn't defined in the node. With Continue On Fail enabled, failed items return { error: message }. In the execute code, only campaignId, triggerSourceId, userIdentifier and the additionalFields collection are sent, and empty strings are skipped. Requires PERS API credentials.

Examples

Example 1: Reward a user who scans a QR code at a partner location

Set Trigger Source ID to the QR trigger's ID and User Identifier to the user's email (e.g. from the previous node).

Example 2: Grant a reward for a payment, once only

Set Trigger Source ID and User Identifier, then add External Reference ID = the payment/order ID to prevent duplicate claims.

Example 3: Claim a geofenced campaign

Set Trigger Source ID and User Identifier, then add Latitude and Longitude from the user's device.

Links

Discussion