Quickstart
Go from a new account to a working reward link in five steps.
1. Create a campaign
In the API dashboard open Campaigns and click New campaign. Add at least one reward, make the shares add up to 100%, then click Start campaign.
2. Turn on API access
The API comes with the Business and Enterprise plans. Pick one under Plan in the API dashboard; until then, calls return 402. API calls are free and you pay only for links. See Paying for links.
3. Get your credentials
Under API credentials, copy your Account SID and create your Auth Token. Keep the token in your secrets manager.
export EFIQ_ACCOUNT_SID=AC1a9e0000000000000000000000000000
export EFIQ_AUTH_TOKEN=your_auth_token4. Create a Service
A Service represents one integration. Set your campaign as its default so you don’t have to pass it on every call.
curl -X POST https://api-rewards.efiqone.com/v1/Services \
-u $EFIQ_ACCOUNT_SID:$EFIQ_AUTH_TOKEN \
--data-urlencode "FriendlyName=HubSpot" \
--data-urlencode "DefaultCampaignSid=CP5b1f…"5. Create a link
curl -X POST https://api-rewards.efiqone.com/v1/Services/RS8f2c…/Links \
-u $EFIQ_ACCOUNT_SID:$EFIQ_AUTH_TOKEN \
-H "Idempotency-Key: 7b0e4d6a-4a5e-4bb0-9a43-0f8c2a6f1e11" \
--data-urlencode "ExternalUserId=hubspot_contact_1042"{
"sid": "LK7d31…",
"service_sid": "RS8f2c…",
"campaign_sid": "CP5b1f…",
"external_user_id": "hubspot_contact_1042",
"link_url": "https://rewards.efiqone.com/g/2kTq8VbnP4xW",
"status": "created",
"reward": null,
"date_expires": "2026-12-31T23:59:59Z",
"is_new": true
}Send link_url to the person through your own email, SMS or WhatsApp. Calling again with the same ExternalUserId returns the same link with is_new: false, so retries never create duplicates.
ExternalUserId is your id for the person. It can’t be an email address or a phone number: the API rejects values that look like one (error 20002), so personal data never reaches us by accident.