# API methods reference index
import { Badge } from '@astrojs/starlight/components';
Pushwoosh provides a vast library of over 100 API methods, categorized for various functionalities like sending notifications, managing users, and tracking analytics.
## Messaging API v2
Unified API that replaces the entire `/create*Message` family (push, email, SMS, Kakao). See the [overview](/developer/api-reference/messaging-api-v2/) and the [migration guide](/developer/api-reference/messaging-api-v2/migration-from-v1/).
| | |
|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| [`Notify`](/developer/api-reference/messaging-api-v2/notify/) | Creates and sends a single message through any channel. Replaces `/createMessage`, `/createTargetedMessage`, `/createEmailMessage`, `/createSMSMessage`, `/createKakaoMessage`. |
| [`Cancel`](/developer/api-reference/messaging-api-v2/cancel/) | Cancels a previously created message before it is delivered. Use with `message_code` from [`Notify`](/developer/api-reference/messaging-api-v2/notify/). |
| [`Update`](/developer/api-reference/messaging-api-v2/update/) | Replaces a still-scheduled message with a new definition (full replace). Use with `message_code` from [`Notify`](/developer/api-reference/messaging-api-v2/notify/). |
## SMTP gateway
Submit transactional email over standard SMTP instead of calling the API directly. The gateway authenticates with your application code and API token, then forwards each message to [`Notify`](/developer/api-reference/messaging-api-v2/notify/). See the [SMTP gateway reference](/developer/api-reference/smtp-gateway/).
## Messages API
| | |
|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| [`createMessage`](/developer/api-reference/messages-api#createmessage) | Creates a new push notification. Use [`Notify`](/developer/api-reference/messaging-api-v2/notify/) instead. |
| [`deleteMessage`](/developer/api-reference/messages-api#deletemessage) | Deletes a scheduled message. |
| [`getMessageDetails`](/developer/api-reference/messages-api#getmessagedetails) | Retrieves the message details. |
| [`createTargetedMessage`](/developer/api-reference/messages-api#createtargetedmessage) | Creates a new targeted push notification. Use [`Notify`](/developer/api-reference/messaging-api-v2/notify/) with `transactional` kind instead. |
| [`getPushHistory`](/developer/api-reference/messages-api#getpushhistory) | Use [`/messages:list`](/developer/api-reference/statistics-api/message-statistics-api/#messageslist) to retrieve message history with detailed data. |
| [`cancelMessage`](/developer/api-reference/messages-api#cancelmessage) | Cancels a scheduled message. |
## Presets API
| | |
|------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| [`createPreset`](/developer/api-reference/presets-api#createpreset) | Creates a new preset. |
| [`getPreset`](/developer/api-reference/presets-api#getpreset) | Retrieves parameters of the specified push preset. |
| [`listPresets`](/developer/api-reference/presets-api/#listpresets) | Retrieves a list of presets created for the app. |
| [`deletePreset`](/developer/api-reference/presets-api#deletepreset) | Deletes a preset from your account. |
## Device API
| | |
|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| [`registerDevice`](/developer/api-reference/device-api#registerdevice) | Registers a device for the application. |
| [`unregisterDevice`](/developer/api-reference/device-api#unregisterdevice) | Removes the device's push token. |
| [`deleteDevice`](/developer/api-reference/device-api#deletedevice) | Deletes a device and all its associated data in the specified application. |
| [`setTags`](/developer/api-reference/device-api#settags) | Sets tag values for the device. |
| [`getTags`](/developer/api-reference/device-api#gettags) | Retrieves tags with their corresponding values for a specific device. |
| [`setBadge`](/developer/api-reference/device-api#setbadge) | Sends the current badge value for a device to Pushwoosh. |
| [`applicationOpen`](/developer/api-reference/device-api#applicationopen) | Registers an app open event. |
| [`pushStat`](/developer/api-reference/device-api#pushstat) | Registers a push open event. |
| [`messageDeliveryEvent`](/developer/api-reference/device-api#messagedeliveryevent) | Registers a push delivery event for the device. |
## Audience API
| | |
|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| [`bulkSetTags`](/developer/api-reference/audience-api/#bulksettags) | Sets tag values for multiple devices. |
| [`bulkSetTags Status`](/developer/api-reference/audience-api/#bulksettags-status) | Returns the status of bulkSetTags operation. |
| [`bulkRegisterDevice`](/developer/api-reference/audience-api/#bulkregisterdevice) | Registers multiple devices in a single request, including optional tag values for each device. |
| [`bulkRegisterDevice Status`](/developer/api-reference/audience-api/#bulkregisterdevice-status) | Retrieves the status and results of a bulk device registration request using a request ID. |
| [`bulkUnregisterDevice`](/developer/api-reference/audience-api/#bulkunregisterdevice) | Unregisters multiple devices in a single request. |
| [`bulkUnregisterDevice Status`](/developer/api-reference/audience-api/#bulkunregisterdevice-status) | Retrieves the status and results of a bulk device unregistration request using a request ID. |
## Tags API
| | |
|----------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
| [`addTag`](/developer/api-reference/tags#addtag) | Creates a tag in your account. |
| [`deleteTag`](/developer/api-reference/tags#deletetag) | Removes a tag with all associated information. |
| [`listTags`](/developer/api-reference/tags#listtags) | Retrieves a list of tags on the account. | |
## Segmentation (Filters) API
| | |
|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|
| [`createFilter`](/developer/api-reference/segmentation-filters-api#createfilter) | Creates a new segment. |
| [`listFilters`](/developer/api-reference/segmentation-filters-api/#listfilters) | Returns a list of available segments with their conditions. |
| [`deleteFilter`](/developer/api-reference/segmentation-filters-api#deletefilter) | Deletes an existing segment. |
| [`exportSegment`](/developer/api-reference/segmentation-filters-api#exportsegment) | Schedules a request to export subscribers matching segment conditions. |
| [`exportSegment Results`](/developer/api-reference/segmentation-filters-api#exportsegment-results) | Retrieves the CSV link for exportSegment results. |
## User-centric API
| | |
|--------------------------------------------------------------------|----------------------------------------------------------------|
| [`registerUser`](/developer/api-reference/user-centric-api#registeruser) | Associates external User ID with a specified device. |
| [`deleteUser`](/developer/api-reference/user-centric-api#deleteuser) | Deletes a user and all devices associated with the specified User ID. |
| [`postEvent`](/developer/api-reference/user-centric-api#postevent) | Calls the event within the app. |
## Events API
| | |
|------------------------------------------------------------------|--------------------------------------|
| [`createEvent`](/developer/api-reference/events#createevent) | Creates an event for the app. |
## Applications API
| | |
|---------------------------------------------------------------------------|-----------------------------------------------------------------|
| [`createApplication`](/developer/api-reference/applications#createapplication) | Creates a new application on the account. |
| [`updateApplication`](/developer/api-reference/applications#updateapplication) | Updates the application settings. |
| [`deleteApplication`](/developer/api-reference/applications#deleteapplication) | Deletes the app from the account. |
| [`getApplication`](/developer/api-reference/applications#getapplication) | Gets details about the app. |
| [`getApplications`](/developer/api-reference/applications#getapplications) | Retrieves a list of applications on the account. |
| [`getApplicationFile`](/developer/api-reference/applications#getapplicationfile) | Retrieves the configuration files related to the app. |
| [`setApplicationPlatformStatus`](/developer/api-reference/applications#setapplicationplatformstatus) | Changes the platform status of the app. |
## Campaigns API
| | |
|-------------------------------------------------------------------|------------------------------------------|
| [`createCampaign`](/developer/api-reference/campaigns#createcampaign) | Creates a new push campaign. |
| [`deleteCampaign`](/developer/api-reference/campaigns#deletecampaign) | Deletes a particular campaign. |
| [`getCampaigns`](/developer/api-reference/campaigns#getcampaigns) | Retrieves a list of campaigns for the app. |
## App configuration API
| | |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`configureApplication for iOS`](/developer/api-reference/app-configuration#configureapplication-for-ios) | Configures the iOS platform for the app. |
| [`configureApplication for Android`](/developer/api-reference/app-configuration#configureapplication-for-android) | Configures the Android platform for the app. |
| [`configureApplication for Mac OS X`](/developer/api-reference/app-configuration#configureapplication-for-mac-os-x) | Configures the macOS platform for the app. |
| [`configureApplication for Windows`](/developer/api-reference/app-configuration#configureapplication-for-windows) | Configures the Windows platform for the app. |
| [`configureApplication for Amazon`](/developer/api-reference/app-configuration#configureapplication-for-amazon) | Configures the Amazon platform for the app. |
| [`configureApplication for Chrome`](/developer/api-reference/app-configuration#configureapplication-for-chrome) | Configures the Chrome platform for the app. |
| [`configureApplication for Safari`](/developer/api-reference/app-configuration#configureapplication-for-safari) | Configures the Safari platform for the app. |
| [`configureApplication for Firefox`](/developer/api-reference/app-configuration#configureapplication-for-firefox) | Configures the Firefox platform for the app. |
| [`configureApplication for Email`](/developer/api-reference/app-configuration#configureapplication-for-email) | Configures the Email platform for the app. |
## Email API
| | |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`createEmailMessage`](/developer/api-reference/email-api#createemailmessage) | Creates an email message. Use [`Notify`](/developer/api-reference/messaging-api-v2/notify/) with `platforms: ["EMAIL"]` and an [`email_payload`](/developer/api-reference/messaging-api-v2/email-payload-reference/) instead. |
| [`registerEmail`](/developer/api-reference/email-api#registeremail) | Registers an email address for the app. |
| [`deleteEmail`](/developer/api-reference/email-api#deleteemail) | Removes an email address from your database. |
| [`setEmailTags`](/developer/api-reference/email-api#setemailtags) | Sets tag values for the specified email address. |
| [`registerEmailUser`](/developer/api-reference/email-api#registeremailuser) | Associates an external User ID with a specified email address. |
## Test devices API
| | |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`createTestDevice`](/developer/api-reference/test-devices#createtestdevice) | Registers a test device for the application. |
| [`listTestDevices`](/developer/api-reference/test-devices#listtestdevices) | Retrieves all test devices registered for the application. |
## Message inbox API
| | |
|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`getInboxMessages`](/developer/api-reference/message-inbox/#getinboxmessages) | Retrieves the list of Inbox messages for a specified HWID. |
| [`inboxStatus`](/developer/api-reference/message-inbox#inboxstatus) | Updates the status of a specific Inbox message. |
## Statistics API
### Message statistics
| | |
|----------------------------------------------|--------------------------------------------------------------------------------------------------|
| [`messages:list`](/developer/api-reference/statistics-api/message-statistics-api/#messageslist) | Retrieves a list of sent messages. |
| [`totalsByIntervals`](/developer/api-reference/statistics-api/message-statistics-api/#totalsbyintervals) | Provides metrics and conversion data aggregated by hour. |
| [`getMessageLog`](/developer/api-reference/statistics-api/message-statistics-api/#getmessagelog) | Retrieves detailed information about sent messages. |
| [`linksInteractions`](/developer/api-reference/statistics-api/message-statistics-api/#emailslinksinteractions) | Provides statistics on email link clicks. |
| [`linksInteractionsDevices`](/developer/api-reference/statistics-api/message-statistics-api/#emailslinksinteractionsdevices) | Lists users who clicked on links in emails. |
| [`bouncedEmails`](/developer/api-reference/statistics-api/message-statistics-api/#bouncedemails) | Provides information on email bounces, complaints, and bounce reasons. |
### Application and subscriber statistics
| | |
|----------------------------------------------|--------------------------------------------------------------------------------------------------|
| [`getApplicationSubscribersStats`](/developer/api-reference/statistics-api/application-subscriber-statistics/#getapplicationsubscribersstats) | Retrieves the app's subscriber statistics, grouped by device type. |
| [`getAppStats`](/developer/api-reference/statistics-api/application-subscriber-statistics/#getappstats) | Retrieves app statistics for a specific time period. |
| [`getSubscribersStatistics`](/developer/api-reference/statistics-api/application-subscriber-statistics/#getsubscribersstatistics) | Retrieves subscriber statistics for a specific time period. |
### Campaign statistics
| | |
|----------------------------------------------|--------------------------------------------------------------------------------------------------|
| [`getCampaignStats`](/developer/api-reference/statistics-api/campaign-statistics/) | Retrieves campaign statistics for a specific time period. |
### Events and tags statistics
| | |
|----------------------------------------------|--------------------------------------------------------------------------------------------------|
| [`getEventStatistics`](/developer/api-reference/statistics-api/events-and-tags-statistics/#geteventstatistics) | Retrieves the number of times an event was triggered during a specific period. |
| [`getTagStats`](/developer/api-reference/statistics-api/events-and-tags-statistics/#gettagstats) | Retrieves statistics for a specific tag. |
## iOS Live Activities API
| | |
|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`startLiveActivity`](/developer/api-reference/ios-live-activities-api#startliveactivity) | Creates a new iOS Live Activity. |
| [`updateLiveActivity`](/developer/api-reference/ios-live-activities-api#updateliveactivity) | Updates an existing iOS Live Activity. |
## Apple Wallet PassKit API
| | |
|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`Apple Wallet PassKit API`](/developer/api-reference/apple-wallet-passkit-api/) | Reference for managing Apple Wallet passes and related configuration in Pushwoosh. |
## Google Wallet API
| | |
|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`Create a pass`](/developer/api-reference/google-wallet-api/#create-a-pass) | Creates the pass in Google Wallet and returns a save link. |
| [`Validate a pass`](/developer/api-reference/google-wallet-api/#validate-a-pass) | Checks a pass configuration without creating it. |
| [`Update a pass`](/developer/api-reference/google-wallet-api/#update-a-pass) | Updates an existing pass. Google delivers the change to saved devices. |
| [`Get a save link`](/developer/api-reference/google-wallet-api/#get-a-save-link) | Returns an "Add to Google Wallet" save link for an existing pass. |
| [`Get a pass`](/developer/api-reference/google-wallet-api/#get-a-pass) | Returns a single stored pass. |
| [`List passes`](/developer/api-reference/google-wallet-api/#list-passes) | Returns a paginated list of passes for an application. |
| [`Set pass state`](/developer/api-reference/google-wallet-api/#set-pass-state) | Activates or invalidates a pass. |
| [`Delete a pass`](/developer/api-reference/google-wallet-api/#delete-a-pass) | Invalidates the pass in Google and removes its Pushwoosh record. |
| [`Get configuration`](/developer/api-reference/google-wallet-api/#get-configuration) | Returns the Google Wallet configuration state for an application. |
| [`Templates`](/developer/api-reference/google-wallet-api/#templates) | Lists pass templates or fetches one as a starting point. |
## Customer Journey API
| | |
|------------------------------------------------------------------------------------------|--------------------------------------------------|
| [`Lifecycle`](/developer/api-reference/customer-journey-api/lifecycle/) | Starts, pauses, finishes, drafts, or archives a journey by its UUID. |
| [`Create and update`](/developer/api-reference/customer-journey-api/create-update/) | Creates a new journey definition or replaces an existing one. |
| [`Start by API`](/developer/api-reference/customer-journey-api/start-by-api/) | Injects users into the API entry point of a running journey. |
| [`Get Journey stats`](/developer/api-reference/customer-journey-api/statistics/) | Obtains stats for a specific journey by its ID. |
| [`Remove users from journeys`](/developer/api-reference/customer-journey-api/drop-users/) | Removes one or more users from all or selected active journeys. |
## Scheduled requests API
| | |
|--------------------------------------------------------------|--------------------------------------------------|
| [`getResults`](/developer/api-reference/scheduled-requests#getresults) | Retrieves the result of a scheduled request. |
## SMS API
| | |
|-------------------------------------------------------------------|-------------------------------|
| [`createSMSMessage`](/developer/api-reference/sms#createsmsmessage) | Creates a new SMS message. Use [`Notify`](/developer/api-reference/messaging-api-v2/notify/) with `platforms: ["SMS"]` instead. |
## WhatsApp API
| | |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`createWhatsAppMessage`](/developer/api-reference/whatsapp#createwhatsappmessage) | Creates a new WhatsApp message. Use [`Notify`](/developer/api-reference/messaging-api-v2/notify/) with `platforms: ["WHATS_APP"]` instead. |
## LINE API
| | |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`createLineMessage`](/developer/api-reference/line-api/) | Creates a new LINE message. Use [`Notify`](/developer/api-reference/messaging-api-v2/notify/) with `platforms: ["LINE"]` instead. |
## Kakao API
| | |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`createKakaoMessage`](/developer/api-reference/kakao/#createkakaomessage) | Sends a Kakao message using an approved template. Use [`Notify`](/developer/api-reference/messaging-api-v2/notify/) with `platforms: ["KAKAO"]` instead. |
## Geozones API
| | |
|-------------------------|-------------|
| [`getNearestZone`](/developer/api-reference/geozones#getnearestzone) | Retrieves the parameters of the nearest geozone and the distance to it. Also records the device location for geo push notifications. |
| [`addGeoZone`](/developer/api-reference/geozones#addgeozone) | Adds a Geozone to a specific app. |
| [`updateGeoZone`](/developer/api-reference/geozones#updategeozone) | Updates Geozone properties such as name, status, content, and range. |
| [`deleteGeoZone`](/developer/api-reference/geozones#deletegeozone) | Removes Geozones from the app. |
| [`addGeoZoneCluster`](/developer/api-reference/geozones#addgeozonecluster) | Adds a Geozone Cluster to the app. |
| [`deleteGeoZoneCluster`](/developer/api-reference/geozones#deletegeozonecluster) | Removes a Geozone Cluster from the app. |
| [`listGeoZones`](/developer/api-reference/geozones#listgeozones) | Retrieves a list of Geozones for the app. |
| [`listGeoZoneClusters`](/developer/api-reference/geozones#listgeozoneclusters) | Retrieves a list of Geozone clusters for the app. |