Creating links

One POST creates one unique link for one person. The same person always gets the same link from the same Service.

Create

ParameterRequiredNotes
ExternalUserIdYesYour id for the person, 1 to 128 characters. Not an email or phone number.
ExternalRefNoYour reference, for example an order or deal id
CampaignNoCampaign SID or reference; defaults to the Service’s campaign
DateExpiresNoEarlier expiry than the default
MetadataNoUp to 10 string pairs, returned in webhooks. No personal data.
JSON body
curl -X POST https://api-rewards.efiqone.com/v1/Services/RS8f2c…/Links \
  -u $EFIQ_ACCOUNT_SID:$EFIQ_AUTH_TOKEN \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-88231" \
  -d '{"externalUserId":"crm_1042","externalRef":"order-88231","metadata":{"tier":"gold"}}'

Statuses

StatusMeaning
createdLink exists, not opened yet
openedThe person opened the link
claimedThey claimed the reward
redeemedThe voucher was used
expiredPast its expiry date
revokedYou revoked it; the page shows it’s no longer valid

Read, list and revoke

Endpoints
GET  /v1/Services/{ServiceSid}/Links?ExternalUserId=crm_1042
GET  /v1/Services/{ServiceSid}/Links/{LinkSid}
GET  /v1/Services/{ServiceSid}/Links/{LinkSid}/Events
POST /v1/Services/{ServiceSid}/Links/{LinkSid}   Status=revoked&RevokeReason=duplicate

Revoking is immediate: the link page stops working and a link.revoked webhook is sent. Revoked links are not refunded.