Loyalty and Engagement — API Reference

Win the loyalty of your customers with promotions and personalized offers

122 endpoints across 8 tags.

Promotions

• GET /v4/promotions/promotion/get-for-client — Get a Profile's promotions as Profile
• POST /v4/promotions/promotion/duplicate — Duplicate existing promotion
• POST /v4/promotions/promotion/activate — Activate a promotion
• POST /v4/promotions/promotion/batch-activate — Batch activate promotions
• POST /v4/promotions/promotion/deactivate — Deactivate a promotion
• POST /v4/promotions/promotion/batch-deactivate — Batch deactivate promotions
• POST /v4/promotions/promotion/deactivate-all-for-client/{identifierType}/{identifierValue} — Deactivate all promotions for a Profile as Workspace
• POST /v4/promotions/promotion/redeem — Redeem a promotion
• POST /v4/promotions/promotion/batch-redeem — Batch redeem promotions
• GET /v4/promotions/v2/promotion/get-for-client/{identifierType}/{identifierValue} — Get a Profile's promotions as Workspace (v2)
• GET /v4/promotions/promotion/get-item-for-client/{identifierType}/{identifierValue} — View promotion details as Profile
• GET /v4/promotions/promotion/get-item-for-client-no-data/{identifierType}/{identifierValue} — View promotion details as Profile
• GET /v4/promotions/promotion/list — View Workspace promotions
• GET /v4/promotions/promotion/diff-list — View recently updated promotions
• GET /v4/promotions/promotion/get-for-client/{identifierType}/{identifierValue} — Get a Profile's promotions as Workspace
• GET /v4/promotions/promotion/get-for-client-possible-to-redeem/{identifierType}/{identifierValue} — Get redeemable promotions of a Profile
• GET /v4/promotions/promotion/{identifierType}/{identifierValue} — Get promotion details as Workspace
• PUT /v4/promotions/promotion/{identifierType}/{identifierValue} — Update a promotion
• GET /v4/promotions/promotion/get-for-client-by-custom-settings/{identifierType}/{identifierValue} — Get Profile promotions by a custom filter
• POST /v4/promotions/promotion/activate-for-client/{identifierType}/{identifierValue} — Activate a promotion as Workspace
• POST /v4/promotions/promotion/batch-activate-for-client/{identifierType}/{identifierValue} — Batch activate promotions as Workspace
• POST /v4/promotions/promotion/deactivate-for-client/{identifierType}/{identifierValue} — Deactivate a promotion as Workspace
• POST /v4/promotions/promotion/batch-deactivate-for-client/{identifierType}/{identifierValue} — Batch deactivate promotions
• POST /v4/promotions/promotion — Create a promotion
• DELETE /v4/promotions/promotion — Delete a promotion
• POST /v4/promotions/promotion/create-or-update — Create or update a promotion
• POST /v4/promotions/voucher/batch-redeem — Batch redeem vouchers
• POST /v4/promotions/voucher/batch-redeem-for-profile — Batch redeem vouchers for profiles
• POST /v4/promotions/v2/sale/process-sale/{identifierType}/{identifierValue} — Process basket
• POST /v4/promotions/sale/process-checkout/{identifierType}/{identifierValue} — Process checkout on POS
• POST /v4/promotions/v2/sale/process-anonymous-sale — Process anonymous Profile's basket
• POST /v4/promotions/sale/process-anonymous-checkout — Process anonymous Profile's checkout on POS

Vouchers

• POST /v4/vouchers/item/assign — Assign a voucher from a pool to Profile
• GET /v4/vouchers/item/get-assigned — Get assigned vouchers
• POST /v4/vouchers/item/get-or-assign — Get or assign and get voucher as Profile
• POST /v4/vouchers/item — Create a voucher
• POST /v4/vouchers/item/bulk-create — Bulk create vouchers
• GET /v4/vouchers/item/list — List all vouchers
• GET /v4/vouchers/item/{voucherUuid} — View voucher details
• PUT /v4/vouchers/item/{voucherUuid} — Update a voucher
• DELETE /v4/vouchers/item/{voucherUuid} — Delete a voucher
• GET /v4/vouchers/item/{searchKey}/{searchValue} — View voucher details by search key
• POST /v4/vouchers/item/assign-for-client — Assign a voucher to a Profile
• GET /v4/vouchers/item/get-assigned-for-client/{clientUuid} — Get vouchers assigned to a Profile (deprecated)
• POST /v4/vouchers/item/get-or-assign-for-client — Get or assign and get voucher as Workspace (deprecated)
• GET /v4/vouchers/item/get-assigned-for-client/by-identifier — Get vouchers assigned to a Profile by identifier
• POST /v4/vouchers/item/get-or-assign-for-client/by-identifier — Get or assign and get voucher as Workspace
• POST /v4/vouchers/item/assign-for-client/by-identifier — Assign and get voucher as Workspace
• POST /v4/vouchers/item/redeem — Redeem a voucher
• GET /v4/vouchers/pool/list — List pools
• POST /v4/vouchers/pool — Create a voucher pool
• GET /v4/vouchers/pool/{poolUuid} — Get pool details
• PUT /v4/vouchers/pool/{poolUuid} — Update a voucher pool
• DELETE /v4/vouchers/pool/{poolUuid} — Delete a voucher pool
• GET /v4/vouchers/item/list/{poolUuid} — List vouchers from a pool
• DELETE /v4/vouchers/item/list/{poolUuid} — Delete vouchers by poolUuid
• POST /v4/vouchers/item/count/{poolUuid} — Count vouchers

Handbills

• GET /v4/promotions/handbill — Get all handbill configurations
• POST /v4/promotions/handbill — Create handbill configuration
• GET /v4/promotions/handbill/{handbillUuid} — Get handbill configuration
• PATCH /v4/promotions/handbill/{handbillUuid} — Update handbill configuration
• GET /v4/promotions/promotion/get-for-client/handbill/{handbillUuid} — Generate handbill for Profile
• GET /v4/promotions/promotion/get-for-client/handbills — Generate batch of handbills for Profile
• GET /v4/promotions/promotion/get-for-client/{identifierType}/{identifierValue}/handbill/{handbillUuid} — Generate handbill for Profile and get Profile promotions
• GET /v4/promotions/v2/promotion/get-for-client/{identifierType}/{identifierValue}/handbill/{handbillUuid} — Generate handbill for Profile (v2)
• GET /v4/promotions/promotion/get-for-client/{identifierType}/{identifierValue}/with-handbills — Generate batch handbill for Profile and get Profile promotions

Screen views

• GET /schema-service/v3/screen-views/{feedSlug}/generate — Generate screen view from feed
• POST /schema-service/v3/screen-views/{feedSlug}/generate — Generate screen view from feed
• POST /schema-service/screen-views/create — Create screen view
• POST /schema-service/v2/screen-views/createNew — Initialize screen view
• POST /schema-service/v2/screen-views/{screenViewId}/content — Add content to screen view
• POST /schema-service/v2/screen-views/{screenViewId}/audience — Add audience to screen view
• PUT /schema-service/v2/screen-views/{screenViewId}/priority — Update screen view priority
• PUT /schema-service/v2/screen-views/{screenViewId}/name — Rename screen view
• POST /schema-service/v2/screen-views/{feedSlug}/generate/by/{identifierType} — Preview screen view with a profile context
• GET /schema-service/v2/screen-views/feeds — List screen view feeds
• POST /schema-service/v2/screen-views/feeds — Create screen view feed
• GET /schema-service/v2/screen-views — List screen views
• GET /schema-service/v2/screen-views/{screenViewId} — Get screen view
• DELETE /schema-service/v2/screen-views/{screenViewId} — Delete screen view
• POST /schema-service/v2/screen-views/{screenViewId}/copy — Copy screen view
• GET /schema-service/v2/screen-views/{screenViewId}/predecessors — Get predecessors for screen view
• GET /schema-service/v2/screen-views/{screenViewId}/successors — Get successors for screen view
• GET /schema-service/v2/screen-views/directory — List screen view directories
• POST /schema-service/v2/screen-views/directory — Add screen view directory
• POST /schema-service/v2/screen-views/directory/{directoryId} — Rename screen view directory
• DELETE /schema-service/v2/screen-views/directory/{directoryId} — Delete screen view directory
• POST /schema-service/v2/screen-views/{screenViewId}/directory/{directoryId}/attach — Assign screen view to directory
• POST /schema-service/v2/screen-views/{screenViewId}/feed — Assign screen view to feed
• POST /schema-service/v2/screen-views/feeds/{feedId} — Rename screen view feed
• DELETE /schema-service/v2/screen-views/feeds/{feedId} — Delete screen view feed
• POST /schema-service/scheduler/entry — Schedule object
• GET /schema-service/scheduler/entry/{objectType}/{objectId} — Get schedule the schedule of an object
• POST /schema-service/v2/screen-views/{screenViewId}/status/finish — Finish screen view
• POST /schema-service/v2/screen-views/{screenViewId}/status/resume — Resume screen view
• POST /schema-service/v2/screen-views/{screenViewId}/status/activate — Activate screen view
• POST /schema-service/v2/screen-views/{screenViewId}/status/pause — Pause screen view

Promotions points

• POST /v4/promotions/v2/points/transfer — Transfer points to another profile

Promotion settings

• GET /v4/promotions/settings — Get settings for current Workspace
• PUT /v4/promotions/settings — Update settings for current Workspace

Promotion locks

• GET /v4/promotions/promotion/locking/check-client — Check account lock
• POST /v4/promotions/lock/create-points-lock-for-client/{identifierType}/{identifierValue} — Create point lock for profile
• POST /v4/promotions/lock/release-points-lock-for-client/{identifierType}/{identifierValue}/{lockIdentifier} — Release point lock for profile
• POST /v4/promotions/lock/release-promotion-requested-lock-for-client/{identifierType}/{identifierValue}/{lockIdentifier} — Release "promotion requested" lock from profile

Screen views (legacy)

• GET /schema-service/screenViews — Get all screen views (deprecated)
• POST /schema-service/screenViews/byKeys — Get screen views by keys (deprecated)
• GET /schema-service/screenViews/single/{screenViewId}/{screenViewVersion} — Get screen view (deprecated)
• GET /schema-service/screenViews/versions/{screenViewId} — Get screen view versions (deprecated)
• GET /schema-service/screenViews/generate — Generate screen view (deprecated)
• GET /schema-service/v2/screenViews/generate — Generate screen view (deprecated)
• POST /schema-service/screenViews/createNew — Initialize screen view (deprecated)
• POST /schema-service/screenViews/content/{screenViewId}/{screenViewVersion}/copyFromExistingScreenView — Copy content (deprecated)
• POST /schema-service/screenViews/content/{screenViewId}/{screenViewVersion} — Add content (deprecated)
• POST /schema-service/screenViews/audience/{screenViewId}/{screenViewVersion} — Add audience (deprecated)
• POST /schema-service/screenViews/publish/{screenViewId}/{screenViewVersion} — Publish screen view (deprecated)
• POST /schema-service/screenViews/copyDraftFromExistingScreenView — Copy draft from existing screen view (deprecated)
• POST /schema-service/screenViews/createDraftFromExistingScreenView — Create draft from existing screen view (deprecated)
• PUT /schema-service/screenViews/single/{screenViewId}/{screenViewVersion}/description — Update screen view description (deprecated)
• PUT /schema-service/screenViews/single/{screenViewId}/{screenViewVersion}/priority — Update screen view priority (deprecated)
• POST /schema-service/screenViews/discardChanges/{screenViewId}/{screenViewVersion} — Discard changes (deprecated)
• DELETE /schema-service/screenViews/delete/{screenViewId} — Delete screen view (deprecated)
• DELETE /schema-service/screenViews/single/delete/{screenViewId}/{screenViewVersion} — Delete screen view version (deprecated)

Back to all API categories