JUMP TODeveloper DashboardMy RequestsWelcome!API Reference: OverviewCreating an API KeyUsing PostmanMerchant & EmployeesMerchantUpdate merchant detailsputUpdate billing contactputUpdate POS IntegrationputFetch all employeesgetFetch public representative employees of the merchantgetFetch wallet configurationgetFetch custom rolesgetFetch all phone numbersgetFetch phone numbergetFetch all TCPA FiltersgetFetch help desk requestsgetFetch inbound SMSesgetCount inbound SMSesgetFetch inbound SMSes by pagegetExport inbound messagesputFetch outbound SMSesgetExport outbound messagesputFetch all opt in listsgetFetch opt in listgetFetch all imported listsgetFetch imported listgetFetch all simple SMS broadcastsgetFetch all dynamic voucher broadcastsgetFetch all ad credit broadcastsgetFetch all static voucher campaign broadcastsgetArchive payment object broadcastdeleteArchive MerchantdeleteEmployeesCreate employee peerpostSet profile pictureputUpdate peerputRetrieve employee's webpagesgetRetrieve employee's webpagesgetMark alerts as readpatchFetch all messagesgetMark messages as readpatchChanges the employee's email notification preference to enabled or disabledputFetch peer permissionsgetModify peer's rolesputRemove peer from all rolesdeleteAdd peer to rolespostExport static voucher campaignputFetch static voucher campaignsgetFetch static voucher campaign groupsgetCreate static voucher campaign grouppostPresign file for uploadpostCreate filepostFetch URL for file downloadgetFetch URL to download a failed importgetImport club memberspostExport club membersputUpdate club membersputImport merchant creditspostExport merchant creditsputCreate employee alertgetMark export data files as readputFetch peer activitygetSend help desk responsepostResolve help desk requestpatchFetch all opt in list sourcesgetFetch opt in list sourcegetFetch all dynamic vouchersgetCreate media filepostDelete media filedeleteFetch all media filesgetCreate documentpostDelete documentdeleteFetch all documentsgetSchedule SMS Campaign BroadcastpostSchedule Simple SMS broadcast to listpostSchedule Simple SMS broadcast to recipientpostSchedule Dynamic Voucher to listpostSchedule Dyanamic Voucher to recipientpostSchedule Ad CreditpostEmployee API KeysFetch all employee API KeysgetFetch API KeygetUpdate employee API KeyputArchive employee API KeydeleteCreate employee API KeypostLogin And LogoutLoginpostRetrieve status of session tokengetLogoutdeleteEmployee AccessRegisterpostSettingsGet active campaignsgetGet vouchers countgetWallet UICustomerFetch all static vouchersgetFetch active static vouchersgetFetch upcoming static vouchersgetFetch expired static vouchersgetFetch redeemed static vouchersgetFetch refunded static vouchersgetFind members with phone numberpostFind members with memberIDpostFetch Wallet Views for SessiongetNewsFetch all news articlesgetCreate news articlepostUpdate news articleputArchive news articledeleteRestore news articlepatchPerformancesFetch all performancesgetCreate performancepostUpdate performanceputArchive performancedeleteRestore performancepatchInteractionsIdentify itemgetIdentify itempostFetch payment object with token NOTE: This route exists because a token can completely change the dataset returned to the client. A simple fetch just logs the token with the request, but a fetchWithToken request can have a very different object returned to the client.postFetch page with token NOTE: This route exists because a token can completely change the dataset returned to the client. A simple fetch just logs the token with the request, but a fetchWithToken request can have a very different object returned to the client.postFetch a customer's static vouchers on the basis of a given voucher IDgetFetch static vouchergetFetch dynamic vouchergetFetch member informationgetCreate ad credit scanpostFetch vanity handlegetFetch ICS for live eventgetFetch an employee's VCardgetImage GridFetch all imagesgetCreate imagepostUpdate imageputArchive imagedeleteRestore imagepatchQuick LinksFetch all linksgetFetch link book by idgetUpdate linkputArchive linkdeleteRestore linkpatchCreate linkpostQuick Links SectionFetch all link book sectionsgetCreate link book sectionpostUpdate link book sectionputArchive link book sectiondeleteRestore link book sectionpatchVirtual Business CardFetch all VirtualBusinessCardsgetFetch virtual business cardgetUpdate VirtualBusinessCardputArchive VirtualBusinessCarddeleteRestore VirtualBusinessCardpatchCreate VirtualBusinessCardpostFetch requestsgetMerchant URLsFetch all merchant urlsgetFetch merchant urlgetUpdate merchant urlputArchive merchant urldeleteRestore merchant urlpatchCreate merchant urlpostFetch requestsgetConfigurationUpdate wallet recordput/v2/wallet/createPublicChatRoompostUpdate wallet recordputCommunicationsApple Wallet SubscribersFetch all subscribersgetFetch subscriber activitygetSMSAccept SMS agreementpostFetch SMS agreementgetAcquire phone numberpostRequest phone number verificationputUpdate phone numberputArchive phone numberdeleteRestore phone numberpatchFetch blocked TCPA entriesgetFetch opt in listsgetFetch opt in sourcesgetCreate opt in listpostSave opt in listputSend SMS to opt in listpostSave opt in list sourceputFetch all opt in list sourcesgetFetch outbound SMSgetCount outbound SMSgetFetch outbound SMSes by pagegetFetch opt in list subscribersgetFetch opt in list subscribers by pagegetCount opt in list subscribersgetImport opt in list subscriberspostExport opt in list subscriberspostFetch opt in source subscribersgetCount opt in source subscribersgetFetch payment object broadcastsgetCreate imported listpostSave imported listputFetch imported list recipientsgetFetch imported list recipients by pagegetCount imported list recipientsgetAdd new recipient in an imported listpostArchive recipientdeleteRestore recipientpatchImport imported list recipientspostImport imported list recipients from a given membership tierpostExport imported list recipientspostRetrieve the number of messages sent by the merchant within the current billing cyclegetPayments & DISCOUNTSPromotion CodesFetch all promo codesgetCreate promo codepostUpdate promo codeputArchive promo codedeleteRestore promo codepatchClub Members & PointsCount active membersgetFetch members by pagepostFetch membergetUpdate memberputArchive memberdeleteRestore memberpatchCreate memberpostSearch for memberspostFetch historypostFetch redemption logpostMembership TiersFetch all tiersgetFetch all tiers with member countgetFetch tiergetUpdate tierputArchive tierdeleteRestore tierpatchCreate tierpostFetch historypostFetch redemption logpostAdvertisement CreditsFetch all active ad creditsgetFetch ad creditgetUpdate ad creditputArchive ad creditdeleteRestore ad creditpatchCreate ad creditpostFetch scansgetPayment DesignsFetch all active payment designsgetFetch payment designgetUpdate payment designputArchive payment designdeleteRestore payment designpatchCreate payment designpostDynamic VouchersFetch all active dynamic vouchersgetFetch dynamic vouchergetUpdate dynamic voucherputFetch redemptionsgetCreate dynamic voucherpostArchive dynamic voucher campaigndeleteRestore dynamic voucher campaignpatchGet the reach statistics of all the dynamic vouchersgetGet the reach statistics of an individual dynamic vouchergetMerchant CreditsFetch all active merchant creditsgetFetch merchant credits by pagepostFetch merchant creditgetUpdate merchant creditputArchive merchant creditdeleteRestore merchant creditpatchCreate merchant creditpostSearch for merchant creditspostFetch historypostFetch redemption logpostStatic Voucher CampaignsFetches all static vouchers campaignsgetFetch static voucher campaigngetCount loaded vouchersgetCount redeemed vouchersgetFetch redeemed vouchersgetDuplicate static voucher campaignpostFetch static vouchersgetFetch static vouchers by pagegetFetch viewsgetPreview static vouchers. This method has been deprecated. Please use /preview/page/{campaignID} for better performance.putPreview static vouchers by pageputCreate static voucher campaign with voucherpostUpdate static voucher campaign with voucherputImport static voucher campaignpostCreate static voucher campaignpostArchive static voucher campaigndeleteRestore static voucher campaignpatchUpdate static voucher campaignputFetch performance overviewgetGet the reach statistics of all the static voucher campaignsgetGet the reach statistics of an individual static voucher campaigngetStatic Voucher Campaign GroupsFetch all campaignsgetStatic VouchersFetch static vouchergetUpdate static voucherputDelete static voucherdeleteCreate static voucherpostGet the reach statistics of all the static vouchersgetGet the reach statistics of an individual static vouchergetEcommerceShopify TerminalFetch itemgetRedeem itempostRefund transactionpostWix TerminalFetch itemgetRedeem itempostRefund transactionpostWooCommerce TerminalFetch itemgetRedeem itempostRefund transactionpostPoint of SaleInfoGenesis ReportsFetch InfoGenesis request with transaction IDgetFetch InfoGenesis requests with routing IDspostFetch InfoGenesis responses with routing IDspostFetch InfoGenesis response errorsgetFetch InfoGenesis lookup requestspostFetch InfoGenesis lookup request errorspostFetch InfoGenesis redemptionspostFetch InfoGenesis transactionspostFetch redeemed static voucherspostFetch refunded static voucherspostFetch InfoGenesis refundspostFetch InfoGenesis authorizationspostFetch redeemed InfoGenesis unique posting IDsgetFetch refunded InfoGenesis unique posting IDspostFetch campaign informationpostCount redeemed ad creditspostCount refunded ad creditspostCount redeemed merchant creditspostCount refunded merchant creditspostCount redeemed membership pointspostCount refunded membership pointspostCount tier redemptionspostCount tier refundspostCount dynamic voucher redemptionspostCount dynamic voucher refundspostCount static voucher redemptionspostCount static voucher refundspostTransaction LedgerFetch ledger transactions by pagegetIntegrated TerminalsFetch all POS machinesgetCreate POS machinepostUpdate POS machineputArchive POS machinedeleteRestore POS machinepatchMobile TerminalFetch itemgetRedeem itempostFind membergetWeb TerminalFetch itemgetRedeem itempostRefund transactionpostSystemDashboardFetch widgets cataloggetCount tiersgetCount membersgetCount POS MachinesgetCount POS TransactionsgetCount POS redemptionsgetCount POS refundsgetCount Outbound SMSgetCount employeesgetCount active static vouchersgetCount active static voucher campaignsgetCount phone numbersgetCount opt in listsgetCount opt in sourcesgetCount Apple Wallet SubscribersgetCount Wallet page viewsgetCount News ArticlesgetCount PerformancesgetSystemFetch role's audit loggetFetch rolegetDelete roledeleteUpdate roleputFetch employees with rolegetFetch webpages for rolegetCreate rolepostUtilitiesGet payment prefixesgetIndustriesFetch all industriesgetBillingFetch usage summarygetSave payment methodputVerify payment methodgetFetch merchant's industrygetFetch subscriptiongetFetch all invoicesgetFetch upcoming invoicesgetChange billing planputCancel billing plan and revert to defaultdeleteFetch add-on products, or 1-time purchase products (non-subscription products)getFetch add-on products, or 1-time purchase products (non-subscription products)postFetch special offer productsgetBuy special offerpostCountriesFetch all countriesgetAnalyticsAnalyticsFetch distinct wallet sessionsgetCount total sessionsgetCount new sessionsgetCount authenticated sessionsgetFetch wallet object counts within a given time framegetFetch wallet object counts within a given time frame that have a valid phone verification tokengetFetch session activitygetFetch session activity by wallet page view IDgetFetch a campaign's wallet page viewsgetFetch a static voucher's wallet page viewsgetFetch wallet page views of itemgetCount membersgetCount redeemed pointsgetCount refunded pointsgetFetch redeemed amoun̥t of tiersgetFetch refunded amount of tiersgetCount merchant creditsgetFetch redeemed amount of merchant creditsgetFetch refunded amount of merchant creditsgetCount help desk requests by dategetCount help desk requests by dategetCount resolved help desk requests by dategetCount unresolved help desk requests by dategetCount resolved help desk requests by employeegetCount TCPA (STOP) entries by dategetCount TCPA (STOP) entries by phone numbergetCount created TCPA Filter entries by dategetCount deleted TCPA Filter entries by dategetCount opt in list subscribersgetCount opt in list subscribers by dategetCount opt in list subscribersgetCount opt in list subscribersgetCount created broadcasts by dategetCount scheduled broadcasts by dategetCount scheduled broadcasts by phone numbergetCount scheduled SMS broadcasts by dategetCount scheduled broadcasts by employeegetFetch execution time of completed broadcastsgetCount sent outbound messages by phone numbergetCount sent outbound messages by dategetCount delivered outbound messages by phone numbergetCount delivered outbound messages by dategetCount ad credits by value typegetCount ad credits by payment designgetCount ad credits by employeegetCount scans of ad credits by dategetCount scans of ad credits by Ad CreditgetCount redemptions of ad credits by dategetCount redemptions of ad credits by Ad CreditgetFetch redemption amount of ad credits by dategetFetch redemption amount of ad credits by Ad CreditgetCount refunds of ad credits by dategetCount refunds of ad credits by Ad CreditgetFetch refund amount of ad credits by dategetFetch refund amount of ad credits by Ad CreditgetCount dynamic vouchers by payment designgetCount dynamic vouchers by employeegetCount redemptions of dynamic vouchers by dategetCount redemptions of dynamic vouchers by dynamic vouchergetFetch redemption amount of dynamic vouchers by dategetFetch redemption amount of dynamic vouchers by dynamic vouchergetCount refunds of dynamic vouchers by dategetCount refunds of dynamic vouchers by dynamic vouchergetFetch refund amount of dynamic vouchers by dategetFetch refund amount of dynamic vouchers by dynamic vouchergetCount campaigns by value typegetCount campaigns by payment designgetCount campaigns by employeegetCount created campaigns by campaigngetFetch offer vs redeemed amount by campaigngetCount redemptions of campaigns by dategetCount redemptions of campaigns by CampaigngetFetch redemption amount of campaigns by dategetFetch redemption amount of campaigns by CampaigngetFetch refund amount of campaigns by dategetFetch refund amount of campaigns by CampaigngetFetch refund amount of campaigns by dategetFetch refund amount of campaigns by CampaigngetFetch refund amount of campaigns by CampaigngetFetch refund amount of campaigns by CampaigngetFetch refund amount of campaigns by CampaigngetFetch refund amount of campaigns by CampaigngetCount TCPA (STOP) entries by dateget https://api.wall.et/v2/analytics/tcpa/count/date/stop
