API reference
Every endpoint, generated from the OpenAPI 3.1 spec. Base URL https://api-rewards.efiqone.com/v1. Download openapi.yaml
Accounts
/Accounts/{AccountSid}Account, plan, API status and credits
Responses: 200, 4XX, 5XX
Keys
/KeysList API keys (secrets never returned)
Query: PageSize, PageToken
Responses: 200, 4XX, 5XX
/KeysCreate an API key (the secret is returned once)
Responses: 201, 4XX, 5XX
/Keys/{KeySid}Fetch an API key
Responses: 200, 4XX, 5XX
/Keys/{KeySid}Update a key's name, description, access, scopes or Services
Responses: 200, 4XX, 5XX
/Keys/{KeySid}Revoke a key (takes effect in under 1 second)
Responses: 204, 4XX, 5XX
Campaigns
/CampaignsCampaigns the credential may use
Query: Status, PageSize, PageToken
Responses: 200, 4XX, 5XX
/Campaigns/{CampaignSid}Fetch a campaign
Responses: 200, 4XX, 5XX
Services
/ServicesList Rewards Services
Query: PageSize, PageToken
Responses: 200, 4XX, 5XX
/ServicesCreate a Rewards Service
Responses: 201, 4XX, 5XX
/Services/{ServiceSid}Fetch a Rewards Service
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}Update a Rewards Service
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}Delete a Service (existing links keep working until they expire)
Responses: 204, 4XX, 5XX
Links
/Services/{ServiceSid}/LinksList links
Query: ExternalUserId, ExternalRef, Campaign, Status, DateCreatedAfter, DateCreatedBefore, PageSize, PageToken
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}/LinksCreate one link (synchronous)
Responses: 200, 201, 4XX, 5XX
/Services/{ServiceSid}/Links/{LinkSid}Fetch a link
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}/Links/{LinkSid}Revoke a link (Status=revoked). Credits are not refunded.
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}/Links/{LinkSid}/EventsTimeline of a link (created, delivered, opened, claimed, redeemed, expired, revoked)
Responses: 200, 4XX, 5XX
Batches
/Services/{ServiceSid}/BatchesList batches
Query: PageSize, PageToken
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}/BatchesCreate up to 10,000 links asynchronously
Responses: 202, 4XX, 5XX
/Services/{ServiceSid}/Batches/{BatchSid}Fetch a batch
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}/Batches/{BatchSid}/ResultsList per-item results of a batch
Query: Status, PageSize, PageToken
Responses: 200, 4XX, 5XX
Recipients
/Services/{ServiceSid}/Recipients/{ExternalUserId}Fetch a recipient and their links
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}/Recipients/{ExternalUserId}Erase a recipient (right to erasure)
Responses: 202, 4XX, 5XX
Webhooks
/Services/{ServiceSid}/WebhooksList webhook endpoints
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}/WebhooksCreate a webhook endpoint (signing key returned once)
Responses: 201, 4XX, 5XX
/Services/{ServiceSid}/Webhooks/{WebhookSid}Fetch a webhook endpoint
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}/Webhooks/{WebhookSid}Update a webhook endpoint
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}/Webhooks/{WebhookSid}Delete a webhook endpoint (always allowed)
Responses: 204, 4XX, 5XX
/Services/{ServiceSid}/Webhooks/{WebhookSid}/RotateSigningKeyRotate the signing key (the old key stays valid for 24h)
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}/Webhooks/{WebhookSid}/TestSend a signed `ping` event and return the result
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}/Webhooks/{WebhookSid}/DeliveriesList webhook deliveries
Query: Status, PageSize, PageToken
Responses: 200, 4XX, 5XX
/Services/{ServiceSid}/Webhooks/{WebhookSid}/Deliveries/{EventSid}/ReplayReplay a webhook delivery
Responses: 202, 4XX, 5XX
Ingest
/Services/{ServiceSid}/IngestAccept a CRM's native webhook payload and create a link using the Service's mapping
Responses: 200, 201, 4XX, 5XX
Usage
/Usage/SummaryUsage totals with a breakdown by credential and by Service
Query: StartDate, EndDate
Responses: 200, 4XX, 5XX
/Usage/RecordsList daily usage records
Query: Category, StartDate, EndDate, ServiceSid
Responses: 200, 4XX, 5XX
Branding
/BrandingGift page branding (scope branding:manage)
Responses: 200, 4XX
/BrandingUpdate name, logo URL, colours, contact and redeem text
Responses: 200, 4XX
/Branding/LogoUpload a logo (PNG, JPEG or WebP, max 512 KB, base64; SVG refused)
Responses: 200, 4XX
/Branding/LogoRemove the uploaded logo (logoUrl is used again if set)
Responses: 200, 4XX
Health
/HealthService health (no authentication, no tenant data)
Responses: 200