Services

A Service (RS…) is one integration. Its settings apply to every link created through it.

FieldMeaning
FriendlyNameYour name for it, for example “HubSpot production”
DefaultCampaignSidCampaign used when a request doesn’t name one
CampaignAccessall = any campaign in your account, including ones created later. selected (default) = only the campaigns in CampaignSids
CampaignSidsCampaigns this Service may use when CampaignAccess is selected. The default campaign is always included
LinkTtlDaysLinks expire after this many days (otherwise the reward’s validity)
RewardRevealon_open (default) or on_create to return the reward in the create response
RetentionDaysHow long link metadata is kept (default 365)
AllowedIpRangesOptional CIDR allowlist
Statusactive or paused; paused Services can’t create links
Update a Service
curl -X POST https://api-rewards.efiqone.com/v1/Services/RS8f2c… \
  -u $EFIQ_ACCOUNT_SID:$EFIQ_AUTH_TOKEN \
  --data-urlencode "LinkTtlDays=14" \
  --data-urlencode "AllowedIpRanges=203.0.113.0/24"

Choosing the campaign per link

Pass Campaign on a create with a Campaign SID or your campaign reference (for example DIWALI24, set in the portal). Without it the Service’s default campaign is used.