Pushwoosh

Checks a pass configuration against Apple’s specifications without creating a file. Useful before calling create.

Generates, signs, and stores a new pass, then returns its server-assigned serial number.

Regenerates the pass with new content, re-signs it, increments its update tag, and sends a silent push notification to e…

Returns a paginated, sorted list of the passes stored for an application.

Returns a single stored pass, including its full pass object.

Returns the stored .pkpass file of an existing pass.

Removes a pass record and its stored .pkpass file.

Lists the devices that have added the pass and are registered for updates.

Returns the PassKit configuration resolved for an application from its certificate.

List the available pass templates, or fetch one as a pass object you can use as a starting point.

Fetch a template as a pass object you can use as a starting point.

Creates a new application on the account.

Updates the application settings.

Deletes the app from the account.

Gets details about the app.

Gets the list of applications on the account. Can return result with pagination.

Gets the configuration files related to the app.

Changes the platform’s status of the app.

Configures the platform for the app. All platforms use the same /configureApplication method; parameters differ per plat…

Sets tag values for the list of devices.

Returns the status of /bulkSetTags operation

Registers multiple devices in Pushwoosh in a single request. It also allows specifying various tags for each device.

You can check the status of a bulk registration process by making the following GET request.

Unregisters multiple devices from Pushwoosh in a single request.

You can check the status of a bulk un-registration process by making the following GET request.

Creates a push campaign within the app.

Deletes a particular campaign.

Retrieves the list of campaigns for the app.

Lists every control group configured for an application, the unnamed original one first.

Creates a named control group for an application and returns it with its generated code. The new group holds users out o…

Returns one control group by its code, with its hold-out size, generation, and the user counts behind it.

Sets the hold-out percentage (1–20) of one control group. Resizing keeps every existing member: the hold-out grows or sh…

Sets the countries one control group is scoped to. Changing the scope restarts the uplift measurement, because the popul…

Applies a control group’s size, country and tag scope, and lifetime mode in one call. A change that alters who is held o…

Sets the name the Control Panel shows for one control group. name is part of the membership key and doesn’t change, so…

Switches one control group off, keeping it and its generation so that switching it back on restores the same hold-out ra…

Redraws one control group’s hold-out by incrementing its generation. This is the only way to get a different sample: mem…

Starts a fresh count of one control group’s size. The previously cached numbers keep being served until the new count fi…

Polls just the changing user counts of one control group while a size calculation runs.

Returns the precomputed Control-vs-Treatment analytics for one control group.

Lists the closed cycles of one control group, newest first. Each cycle is the membership the group ran with between two…

Reports for each user ID whether it is held out by one control group right now. Membership is computed from the ID alone…

Removes a control group entirely. It stops holding users out, and its statistics can no longer be opened. The applicatio…

Starts erasing the personal data of the listed subjects in the listed applications. With dry_run: true the task only c…

Returns every erasure of a period as one CSV file: a row per identifier per application, with the task and its initiator…

Returns one erasure task with its status and counters. Use it to follow a task started by Create or Upload.

Returns the whole report of one task as a CSV file: one row per identifier per application, with its outcome. ListTaskRo…

Returns the per-identifier outcome of one task: what was deleted, not found, skipped, or failed. Identifiers are reporte…

Lists the erasures of the account, newest first: the audit journal of who erased what and when. Dry runs are left out un…

Creates the same kind of task as Create, but the identifiers come from an uploaded CSV instead of a JSON array. Use this…

Deletes a device and all its associated data identified by the specified HWID within the application. Unlike /unregister…

Retrieves a list of tags with corresponding values for the specific device.

Called internally from the SDK. Registers device for the application.

This endpoint is disabled. The server no longer stores or acts on the badge value it receives. Badge state is managed en…

Sets tags values for the device. Called from the SDK.

Registers an app open event. Called internally from the SDK.

Registers push delivery event for the device. Called internally from the SDK.

Registers a push open event. Called internally from the SDK.

Removes the device’s push token. The unregistered device is still counted in Total Devices and can be reached with In-Ap…

Registers email address for the app.

Removes email address from your user base.

Sets tag values for the email address.

Associates an external User ID with a specified email address.

Creates a new email template - its editor content plus a connected email preset - in an application, and returns the gen…

Lists an application’s email templates - metadata only, no content - with paging, ordering, and filtering by name, label…

Returns a single email template by its code, including sender info, per-locale subjects, and the full editor content.

Updates an existing email template by code, overwriting the supplied fields.

Deletes an email template and its connected preset by code, removing the stored content.

Clones an email template - its content and preset - into a destination application, optionally under a new name.

Creates an Event for the app.

Called internally from the SDK. Retrieves the parameters of the nearest geozone and the distance to it. Also records the…

Adds a Geozone to a specific app.

Updates Geozone properties.

Removes Geozones from the app.

Adds Geozone Cluster to the app.

Removes a Geozone Cluster from the app.

Retrieves a list of Geozones for the app.

Retrieves a list of Geozone clusters for the app.

Checks a pass configuration against Google’s requirements without creating it. Useful before calling create.

Creates the pass class and object in Google Wallet, then returns the server-assigned serial number, the full object id,…

Patches the pass object with new content. Google then delivers the updated version to every device that saved the pass…

Returns an “Add to Google Wallet” save link for an already created pass. The pass object must already exist (created via…

Returns a single stored pass, including its full pass object.

Returns a paginated, sorted list of the passes stored for an application.

Activates or invalidates a pass. An invalidated (inactive) pass moves to the user’s Expired passes section in Google Wal…

Invalidates the pass in Google and removes its stored record in Pushwoosh.

Returns the Google Wallet configuration state for an application.

List the available example pass templates, or fetch one as a pass object you can use as a starting point.

List the available example pass templates, or fetch one as a pass object you can use as a starting point.

Returns the list of Inbox messages for a specified HWID.

Updates the status of a particular Inbox message.

Creates a new journey in the STATUS_DRAFT state.

Replaces the definition of an existing journey. Send the complete definition. The points and comments you submit replace…

Changes only the journey title, without touching its points or settings.

Moves a journey to STATUS_RUNNING. Pass the Journey ID as uuid in the request body. Returns the updated journey object.

Moves a journey to STATUS_PAUSED. Pass the Journey ID as uuid in the request body. Returns the updated journey object.

Moves a journey to STATUS_FINISHED. Pass the Journey ID as uuid in the request body. Returns the updated journey object.

Moves a journey to STATUS_ARCHIVED. Pass the Journey ID as uuid in the request body. Archived is terminal and cannot be…

Enters a set of users into a journey’s API entry point. Use it to drive journeys from your own backend.

Returns statistics for a Customer Journey by its ID.

Removes a list of users from all or specific active journeys.

Allows creating iOS Live Activities.

Allows updating and ending iOS Live Activities

Creates and schedules a single message.

Cancels a previously created message, identified by its message_code. Cancellation is available only while the message i…

Replaces a previously created message, identified by its message_code, with a new definition. The replacement is a full…

Deletes a message, whether it’s still scheduled or has already been sent. For a scheduled message, this also removes it…

Retrieves the message details.

Creates a new push preset in an application and returns it with its generated code.

Lists an application’s push presets - a reduced field set, not the full object - with paging, ordering, and filtering by…

Returns a single push preset by its code, with every field of the Preset object populated.

Overwrites an existing push preset by code with the supplied fields.

Updates only the supplied fields of an existing push preset by code, leaving unset fields unchanged.

Duplicates an existing push preset, under a new name, into the same application.

Permanently deletes a push preset by code.

Retrieves the result of a scheduled request.

Creates a new filter.

Returns a list of available segments (filters) with their conditions.

Deletes an existing filter.

A scheduled request. Exports the list of subscribers that fall under specified Filter conditions.

Retrieves the link to the CSV with the /exportSegment results.

Displays the list of sent messages.

Returns metrics and conversion data based on the message code, aggregated by hour.

Returns one message’s funnel.

Sums getDeliveryFunnel over a campaign’s messages. Unique counts are calculated per message: a subscriber reached by sev…

Displays detailed information about the messages sent.

Displays statistics on link clicks in emails

Shows users who clicked on links in emails

Provides data on email complaints, soft bounces, and hard bounces, including the date, email address, and reason for eac…

Displays the app’s subscribers list grouped by the types of their devices.

Get the statistics of a specific app for a defined time period.

Retrieves app subscribers stats for a time period.

Retrieve statistics of a particular campaign for a specific time period.

Retrieves the number of times an event was triggered during a specified period.

Retrieves statistics for a specific tag.

Returns totals for the period. Pass inapp_codes to report on specific campaigns, or omit it to walk every in-app of the…

Queues a message history export and returns a task identifier right away.

Returns the progress of an export task.

Returns the generated file name once the task has completed.

Lists recent export tasks for an application, most recent first.

Deletes a task and its file before the 7-day retention window expires.

Downloads the CSV file generated by result, by name.

Creates a tag in your account.

Completely removes a tag with all the associated information from the database.

Retrieves a list of tags on the account.

Registers a test device for the application.

Returns all the test devices for the specific application.

Associates external User ID with a specified device.

Deletes a user and all devices associated with the specified User ID within the application. The request is processed as…

Triggers an event.