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 ProfilePOST/v4/promotions/promotion/duplicate— Duplicate existing promotionPOST/v4/promotions/promotion/activate— Activate a promotionPOST/v4/promotions/promotion/batch-activate— Batch activate promotionsPOST/v4/promotions/promotion/deactivate— Deactivate a promotionPOST/v4/promotions/promotion/batch-deactivate— Batch deactivate promotionsPOST/v4/promotions/promotion/deactivate-all-for-client/{identifierType}/{identifierValue}— Deactivate all promotions for a Profile as WorkspacePOST/v4/promotions/promotion/redeem— Redeem a promotionPOST/v4/promotions/promotion/batch-redeem— Batch redeem promotionsGET/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 ProfileGET/v4/promotions/promotion/get-item-for-client-no-data/{identifierType}/{identifierValue}— View promotion details as ProfileGET/v4/promotions/promotion/list— View Workspace promotionsGET/v4/promotions/promotion/diff-list— View recently updated promotionsGET/v4/promotions/promotion/get-for-client/{identifierType}/{identifierValue}— Get a Profile's promotions as WorkspaceGET/v4/promotions/promotion/get-for-client-possible-to-redeem/{identifierType}/{identifierValue}— Get redeemable promotions of a ProfileGET/v4/promotions/promotion/{identifierType}/{identifierValue}— Get promotion details as WorkspacePUT/v4/promotions/promotion/{identifierType}/{identifierValue}— Update a promotionGET/v4/promotions/promotion/get-for-client-by-custom-settings/{identifierType}/{identifierValue}— Get Profile promotions by a custom filterPOST/v4/promotions/promotion/activate-for-client/{identifierType}/{identifierValue}— Activate a promotion as WorkspacePOST/v4/promotions/promotion/batch-activate-for-client/{identifierType}/{identifierValue}— Batch activate promotions as WorkspacePOST/v4/promotions/promotion/deactivate-for-client/{identifierType}/{identifierValue}— Deactivate a promotion as WorkspacePOST/v4/promotions/promotion/batch-deactivate-for-client/{identifierType}/{identifierValue}— Batch deactivate promotionsPOST/v4/promotions/promotion— Create a promotionDELETE/v4/promotions/promotion— Delete a promotionPOST/v4/promotions/promotion/create-or-update— Create or update a promotionPOST/v4/promotions/voucher/batch-redeem— Batch redeem vouchersPOST/v4/promotions/voucher/batch-redeem-for-profile— Batch redeem vouchers for profilesPOST/v4/promotions/v2/sale/process-sale/{identifierType}/{identifierValue}— Process basketPOST/v4/promotions/sale/process-checkout/{identifierType}/{identifierValue}— Process checkout on POSPOST/v4/promotions/v2/sale/process-anonymous-sale— Process anonymous Profile's basketPOST/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 ProfileGET/v4/vouchers/item/get-assigned— Get assigned vouchersPOST/v4/vouchers/item/get-or-assign— Get or assign and get voucher as ProfilePOST/v4/vouchers/item— Create a voucherPOST/v4/vouchers/item/bulk-create— Bulk create vouchersGET/v4/vouchers/item/list— List all vouchersGET/v4/vouchers/item/{voucherUuid}— View voucher detailsPUT/v4/vouchers/item/{voucherUuid}— Update a voucherDELETE/v4/vouchers/item/{voucherUuid}— Delete a voucherGET/v4/vouchers/item/{searchKey}/{searchValue}— View voucher details by search keyPOST/v4/vouchers/item/assign-for-client— Assign a voucher to a ProfileGET/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 identifierPOST/v4/vouchers/item/get-or-assign-for-client/by-identifier— Get or assign and get voucher as WorkspacePOST/v4/vouchers/item/assign-for-client/by-identifier— Assign and get voucher as WorkspacePOST/v4/vouchers/item/redeem— Redeem a voucherGET/v4/vouchers/pool/list— List poolsPOST/v4/vouchers/pool— Create a voucher poolGET/v4/vouchers/pool/{poolUuid}— Get pool detailsPUT/v4/vouchers/pool/{poolUuid}— Update a voucher poolDELETE/v4/vouchers/pool/{poolUuid}— Delete a voucher poolGET/v4/vouchers/item/list/{poolUuid}— List vouchers from a poolDELETE/v4/vouchers/item/list/{poolUuid}— Delete vouchers by poolUuidPOST/v4/vouchers/item/count/{poolUuid}— Count vouchers
Handbills
GET/v4/promotions/handbill— Get all handbill configurationsPOST/v4/promotions/handbill— Create handbill configurationGET/v4/promotions/handbill/{handbillUuid}— Get handbill configurationPATCH/v4/promotions/handbill/{handbillUuid}— Update handbill configurationGET/v4/promotions/promotion/get-for-client/handbill/{handbillUuid}— Generate handbill for ProfileGET/v4/promotions/promotion/get-for-client/handbills— Generate batch of handbills for ProfileGET/v4/promotions/promotion/get-for-client/{identifierType}/{identifierValue}/handbill/{handbillUuid}— Generate handbill for Profile and get Profile promotionsGET/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 feedPOST/schema-service/v3/screen-views/{feedSlug}/generate— Generate screen view from feedPOST/schema-service/screen-views/create— Create screen viewPOST/schema-service/v2/screen-views/createNew— Initialize screen viewPOST/schema-service/v2/screen-views/{screenViewId}/content— Add content to screen viewPOST/schema-service/v2/screen-views/{screenViewId}/audience— Add audience to screen viewPUT/schema-service/v2/screen-views/{screenViewId}/priority— Update screen view priorityPUT/schema-service/v2/screen-views/{screenViewId}/name— Rename screen viewPOST/schema-service/v2/screen-views/{feedSlug}/generate/by/{identifierType}— Preview screen view with a profile contextGET/schema-service/v2/screen-views/feeds— List screen view feedsPOST/schema-service/v2/screen-views/feeds— Create screen view feedGET/schema-service/v2/screen-views— List screen viewsGET/schema-service/v2/screen-views/{screenViewId}— Get screen viewDELETE/schema-service/v2/screen-views/{screenViewId}— Delete screen viewPOST/schema-service/v2/screen-views/{screenViewId}/copy— Copy screen viewGET/schema-service/v2/screen-views/{screenViewId}/predecessors— Get predecessors for screen viewGET/schema-service/v2/screen-views/{screenViewId}/successors— Get successors for screen viewGET/schema-service/v2/screen-views/directory— List screen view directoriesPOST/schema-service/v2/screen-views/directory— Add screen view directoryPOST/schema-service/v2/screen-views/directory/{directoryId}— Rename screen view directoryDELETE/schema-service/v2/screen-views/directory/{directoryId}— Delete screen view directoryPOST/schema-service/v2/screen-views/{screenViewId}/directory/{directoryId}/attach— Assign screen view to directoryPOST/schema-service/v2/screen-views/{screenViewId}/feed— Assign screen view to feedPOST/schema-service/v2/screen-views/feeds/{feedId}— Rename screen view feedDELETE/schema-service/v2/screen-views/feeds/{feedId}— Delete screen view feedPOST/schema-service/scheduler/entry— Schedule objectGET/schema-service/scheduler/entry/{objectType}/{objectId}— Get schedule the schedule of an objectPOST/schema-service/v2/screen-views/{screenViewId}/status/finish— Finish screen viewPOST/schema-service/v2/screen-views/{screenViewId}/status/resume— Resume screen viewPOST/schema-service/v2/screen-views/{screenViewId}/status/activate— Activate screen viewPOST/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 WorkspacePUT/v4/promotions/settings— Update settings for current Workspace
Promotion locks
GET/v4/promotions/promotion/locking/check-client— Check account lockPOST/v4/promotions/lock/create-points-lock-for-client/{identifierType}/{identifierValue}— Create point lock for profilePOST/v4/promotions/lock/release-points-lock-for-client/{identifierType}/{identifierValue}/{lockIdentifier}— Release point lock for profilePOST/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)