API reference

Every endpoint, generated from the OpenAPI 3.1 spec. Base URL https://api-rewards.efiqone.com/v1. Download openapi.yaml

Accounts

get/Accounts/{AccountSid}

Account, plan, API status and credits

Responses: 200, 4XX, 5XX

Keys

get/Keys

List API keys (secrets never returned)

Query: PageSize, PageToken

Responses: 200, 4XX, 5XX

post/Keys

Create an API key (the secret is returned once)

Responses: 201, 4XX, 5XX

get/Keys/{KeySid}

Fetch an API key

Responses: 200, 4XX, 5XX

post/Keys/{KeySid}

Update a key's name, description, access, scopes or Services

Responses: 200, 4XX, 5XX

delete/Keys/{KeySid}

Revoke a key (takes effect in under 1 second)

Responses: 204, 4XX, 5XX

Campaigns

get/Campaigns

Campaigns the credential may use

Query: Status, PageSize, PageToken

Responses: 200, 4XX, 5XX

get/Campaigns/{CampaignSid}

Fetch a campaign

Responses: 200, 4XX, 5XX

Services

get/Services

List Rewards Services

Query: PageSize, PageToken

Responses: 200, 4XX, 5XX

post/Services

Create a Rewards Service

Responses: 201, 4XX, 5XX

get/Services/{ServiceSid}

Fetch a Rewards Service

Responses: 200, 4XX, 5XX

post/Services/{ServiceSid}

Update a Rewards Service

Responses: 200, 4XX, 5XX

delete/Services/{ServiceSid}

Delete a Service (existing links keep working until they expire)

Responses: 204, 4XX, 5XX

post/Services/{ServiceSid}/Links

Create one link (synchronous)

Responses: 200, 201, 4XX, 5XX

post/Services/{ServiceSid}/Links/{LinkSid}

Revoke a link (Status=revoked). Credits are not refunded.

Responses: 200, 4XX, 5XX

Batches

get/Services/{ServiceSid}/Batches

List batches

Query: PageSize, PageToken

Responses: 200, 4XX, 5XX

post/Services/{ServiceSid}/Batches

Create up to 10,000 links asynchronously

Responses: 202, 4XX, 5XX

get/Services/{ServiceSid}/Batches/{BatchSid}

Fetch a batch

Responses: 200, 4XX, 5XX

get/Services/{ServiceSid}/Batches/{BatchSid}/Results

List per-item results of a batch

Query: Status, PageSize, PageToken

Responses: 200, 4XX, 5XX

Recipients

get/Services/{ServiceSid}/Recipients/{ExternalUserId}

Fetch a recipient and their links

Responses: 200, 4XX, 5XX

delete/Services/{ServiceSid}/Recipients/{ExternalUserId}

Erase a recipient (right to erasure)

Responses: 202, 4XX, 5XX

Webhooks

get/Services/{ServiceSid}/Webhooks

List webhook endpoints

Responses: 200, 4XX, 5XX

post/Services/{ServiceSid}/Webhooks

Create a webhook endpoint (signing key returned once)

Responses: 201, 4XX, 5XX

get/Services/{ServiceSid}/Webhooks/{WebhookSid}

Fetch a webhook endpoint

Responses: 200, 4XX, 5XX

post/Services/{ServiceSid}/Webhooks/{WebhookSid}

Update a webhook endpoint

Responses: 200, 4XX, 5XX

delete/Services/{ServiceSid}/Webhooks/{WebhookSid}

Delete a webhook endpoint (always allowed)

Responses: 204, 4XX, 5XX

post/Services/{ServiceSid}/Webhooks/{WebhookSid}/RotateSigningKey

Rotate the signing key (the old key stays valid for 24h)

Responses: 200, 4XX, 5XX

post/Services/{ServiceSid}/Webhooks/{WebhookSid}/Test

Send a signed `ping` event and return the result

Responses: 200, 4XX, 5XX

get/Services/{ServiceSid}/Webhooks/{WebhookSid}/Deliveries

List webhook deliveries

Query: Status, PageSize, PageToken

Responses: 200, 4XX, 5XX

post/Services/{ServiceSid}/Webhooks/{WebhookSid}/Deliveries/{EventSid}/Replay

Replay a webhook delivery

Responses: 202, 4XX, 5XX

Ingest

post/Services/{ServiceSid}/Ingest

Accept a CRM's native webhook payload and create a link using the Service's mapping

Responses: 200, 201, 4XX, 5XX

Usage

get/Usage/Summary

Usage totals with a breakdown by credential and by Service

Query: StartDate, EndDate

Responses: 200, 4XX, 5XX

get/Usage/Records

List daily usage records

Query: Category, StartDate, EndDate, ServiceSid

Responses: 200, 4XX, 5XX

Branding

get/Branding

Gift page branding (scope branding:manage)

Responses: 200, 4XX

post/Branding

Update name, logo URL, colours, contact and redeem text

Responses: 200, 4XX

Health

get/Health

Service health (no authentication, no tenant data)

Responses: 200