Skip to main content

API changelog

Integrator-visible changes to /api/v1 and outgoing webhooks, newest first. The rules for changes and removals are in the versioning and deprecation policy.

Each entry has a tag: Added (new, compatible), Changed (different behaviour, contract intact), Fixed or Deprecated (with a removal date).

2026-11​

DateTypeChange
2026-11-02AddedAsynchronous bulk jobs: POST /api/v1/jobs/import and POST /api/v1/jobs/export (resource members, Idempotency-Key required, size limits), GET /api/v1/jobs/{id} with a link to the result (GET /api/v1/jobs/{id}/result, kept 7 days) and the job.completed webhook. Uses the existing members:write / members:read scopes. See Webhooks.
2026-11-01AddedCampaign management: /api/v1/campaigns (create, update, delete drafts, activate, pause), custom fields and participation rules. New scopes campaigns:read and campaigns:write. See Management API.
2026-11-01AddedRewards catalogue (/api/v1/rewards) and coupon management: listing, batch issuing with a mandatory Idempotency-Key, and invalidation. New scopes rewards:read, rewards:write, coupons:read and coupons:manage.
2026-11-01AddedGET /api/v1/campaigns/{id}/raffles: completed raffles with masked winners and reserves (scope raffles:read).
2026-11-01AddedGET /api/v1/member-attributes: schema of the custom member attributes (scope read).
2026-11-01AddedLifecycle webhooks: participation.created, participation.validated, participation.rejected, game.played, raffle.drawn, coupon.issued, member.updated, member.anonymized, payout.completed and payout.failed; prize.won now also covers participants without a member account. See Webhooks.
2026-11-01AddedWebhook destination in your SQS queue or SNS topic, and a daily event export to S3 (NDJSON). See Events to your queue or bucket.
2026-11-01AddedOAuth2 client credentials (POST /connect/token) as an alternative to the API key. See OAuth2.
2026-11-01Addedadmin:* and admin:<permission> scopes to call /api/services/app/* with a service account. See Admin scopes.
2026-11-01AddedAccount test mode and mk_test_ keys; X-IncentIA-Test-Mode header. See Test mode.
2026-11-01AddedProgram and tier management: GET/POST /api/v1/programs, GET/PATCH/DELETE /api/v1/programs/{id} and the same on /api/v1/tiers. New scopes programs:read and programs:write (must be granted explicitly, also to keys without scopes). Cursor-paginated lists.
2026-11-01AddedIdempotency-Key also on PATCH and DELETE /api/v1/*.

2026-10​

DateTypeChange
2026-10-31AddedIdempotency-Key on POST /api/v1/*: a retry with the same key and the same content does not repeat the operation.
2026-10-31AddedCursor pagination on a member's transactions: the response includes nextCursor and limit accepts up to 200. offset pagination still works.
2026-10-27FixedResending an externalReference already used for a different operation type returns 409 and moves no points. A same-type resend stays idempotent.
2026-10-27FixedAn out-of-range offset is clamped instead of failing.

Earlier​

TypeChange
ChangedPurchases with a zero or negative amount are rejected.
AddedOutgoing webhooks signed with X-Signature in v1= format over {X-Timestamp}.{X-IncentIA-Idempotency-Key}.{body}. See Webhooks.

How you hear about changes​

  • This page is updated in the same change that alters the contract.
  • Deprecations are also notified to account administrators, on the timelines in the policy.