Search code, repositories, users, issues, pull requests...

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

copy_template_to_app

crate::models::TemplateResource copy_template_to_app(template_id, app_id, copy_template_request) Copy template to another app

Copy a template to a destination app.

Parameters

Name	Type	Required
template_id	String	[required]
app_id	String	[required]
copy_template_request	CopyTemplateRequest	[required]

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

create_alias

crate::models::UserIdentityBody create_alias(app_id, alias_label, alias_id, user_identity_body)

Upserts one or more Aliases to an existing User identified by (:alias_label, :alias_id).

Parameters

Name	Type	Required
app_id	String	[required]
alias_label	String	[required]
alias_id	String	[required]
user_identity_body	UserIdentityBody	[required]

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

create_alias_by_subscription

crate::models::UserIdentityBody create_alias_by_subscription(app_id, subscription_id, user_identity_body)

Upserts one or more Aliases for the User identified by :subscription_id.

Parameters

Name	Type	Required
app_id	String	[required]
subscription_id	String	[required]
user_identity_body	UserIdentityBody	[required]

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

crate::models::CreateApiKeyResponse

create_api_key

crate::models::CreateApiKeyResponse create_api_key(app_id, create_api_key_request) Create API key

Use this API to create a new App API Key (also called a Rich Authentication Token) for a specific OneSignal app. These keys are used to authenticate API requests at the app level and offer enhanced security features, including optional IP allowlisting.

Parameters

Name	Type	Description	Required	Notes
app_id	String		[required]
create_api_key_request	CreateApiKeyRequest		[required]

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

create_app

crate::models::App create_app(app) Create an app

Creates a new OneSignal app

Parameters

Name	Type	Description	Required	Notes
app	App		[required]

Return type

crate::models::App

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

create_custom_events

serde_json::Value create_custom_events(app_id, custom_events_request) Create custom events

The Custom Events API allows you to record user events. Custom events can represent any action users take in your application, such as completing a purchase, viewing content, or achieving milestones.

Parameters

Name	Type	Description	Required	Notes
app_id	String	Your OneSignal App ID in UUID v4 format.	[required]
custom_events_request	CustomEventsRequest		[required]

Return type

serde_json::Value

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

crate::models::CreateNotificationSuccessResponse

create_notification

crate::models::CreateNotificationSuccessResponse create_notification(notification) Create notification

Sends notifications to your users

Parameters

Name	Type	Description	Required	Notes
notification	Notification		[required]

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

crate::models::CreateSegmentSuccessResponse

create_segment

crate::models::CreateSegmentSuccessResponse create_segment(app_id, segment) Create Segment

Create a segment visible and usable in the dashboard and API - Required: OneSignal Paid Plan The Create Segment method is used when you want your server to programmatically create a segment instead of using the OneSignal Dashboard UI. Just like creating Segments from the dashboard you can pass in filters with multiple "AND" or "OR" operator's. 🚧 Does Not Update Segments This endpoint will only create segments, it does not edit or update currently created Segments. You will need to use the Delete Segment endpoint and re-create it with this endpoint to edit.

Parameters

Name	Type	Description	Required	Notes
app_id	String	The OneSignal App ID for your app. Available in Keys & IDs.	[required]
segment	Option<Segment>

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

crate::models::SubscriptionBody

create_subscription

crate::models::SubscriptionBody create_subscription(app_id, alias_label, alias_id, subscription_body)

Creates a new Subscription under the User provided. Useful to add email addresses and SMS numbers to the User.

Parameters

Name	Type	Required
app_id	String	[required]
alias_label	String	[required]
alias_id	String	[required]
subscription_body	SubscriptionBody	[required]

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

create_template

crate::models::TemplateResource create_template(create_template_request) Create template

Create reusable message templates for push, email, and SMS channels.

Parameters

Name	Type	Description	Required	Notes
create_template_request	CreateTemplateRequest		[required]

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

create_user

crate::models::User create_user(app_id, user)

Creates a User, optionally Subscriptions owned by the User as well as Aliases. Aliases provided in the payload will be used to look up an existing User.

Parameters

Name	Type	Description	Required	Notes
app_id	String		[required]
user	User		[required]

Return type

crate::models::User

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

delete_alias

crate::models::UserIdentityBody delete_alias(app_id, alias_label, alias_id, alias_label_to_delete)

Deletes an alias by alias label

Parameters

Name	Type	Required
app_id	String	[required]
alias_label	String	[required]
alias_id	String	[required]
alias_label_to_delete	String	[required]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_api_key

serde_json::Value delete_api_key(app_id, token_id) Delete API key

Delete a specific Rich Authentication Token (App API Key) for a OneSignal app. Requires your Organization API Key and the token’s unique ID, not the token value itself.

Parameters

Name	Type	Description	Required	Notes
app_id	String		[required]
token_id	String		[required]

Return type

serde_json::Value

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_segment

crate::models::GenericSuccessBoolResponse delete_segment(app_id, segment_id) Delete Segment

Delete a segment (not user devices) - Required: OneSignal Paid Plan You can delete a segment under your app by calling this API. You must provide an API key in the Authorization header that has admin access on the app. The segment_id can be found in the URL of the segment when viewing it in the dashboard.

Parameters

Name	Type	Description	Required	Notes
app_id	String	The OneSignal App ID for your app. Available in Keys & IDs.	[required]
segment_id	String	The segment_id can be found in the URL of the segment when viewing it in the dashboard.	[required]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_subscription

delete_subscription(app_id, subscription_id)

Deletes the Subscription.

Parameters

Name	Type	Description	Required	Notes
app_id	String		[required]
subscription_id	String		[required]

Return type

(empty response body)

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_template

crate::models::GenericSuccessBoolResponse delete_template(template_id, app_id) Delete template

Delete a template by id.

Parameters

Name	Type	Description	Required	Notes
template_id	String		[required]
app_id	String		[required]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_user

delete_user(app_id, alias_label, alias_id)

Removes the User identified by (:alias_label, :alias_id), and all Subscriptions and Aliases

Parameters

Name	Type	Required
app_id	String	[required]
alias_label	String	[required]
alias_id	String	[required]

Return type

(empty response body)

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

crate::models::ExportEventsSuccessResponse

export_events

crate::models::ExportEventsSuccessResponse export_events(notification_id, app_id) Export CSV of Events

Generate a compressed CSV report of all of the events data for a notification. This will return a URL immediately upon success but it may take several minutes for the CSV to become available at that URL depending on the volume of data. Only one export can be in-progress per OneSignal account at any given time.

Parameters

Name	Type	Description	Required	Notes
notification_id	String	The ID of the notification to export events from.	[required]
app_id	String	The ID of the app that the notification belongs to.	[required]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

crate::models::ExportSubscriptionsSuccessResponse

export_subscriptions

crate::models::ExportSubscriptionsSuccessResponse export_subscriptions(app_id, export_subscriptions_request_body) Export CSV of Subscriptions

Generate a compressed CSV export of all of your current user data This method can be used to generate a compressed CSV export of all of your current user data. It is a much faster alternative than retrieving this data using the /players API endpoint. The file will be compressed using GZip. The file may take several minutes to generate depending on the number of users in your app. The URL generated will be available for 3 days and includes random v4 uuid as part of the resource name to be unguessable. 🚧 403 Error Responses You can test if it is complete by making a GET request to the csv_file_url value. This file may take time to generate depending on how many device records are being pulled. If the file is not ready, a 403 error will be returned. Otherwise the file itself will be returned. 🚧 Requires Authentication Key Requires your OneSignal App's REST API Key, available in Keys & IDs. 🚧 Concurrent Exports Only one concurrent export is allowed per OneSignal account. Please ensure you have successfully downloaded the .csv.gz file before exporting another app. CSV File Format: - Default Columns: | Field | Details | | --- | --- | | id | OneSignal Player Id | | identifier | Push Token | | session_count | Number of times they visited the app or site | language | Device language code | | timezone | Number of seconds away from UTC. Example: -28800 | | game_version | Version of your mobile app gathered from Android Studio versionCode in your App/build.gradle and iOS uses kCFBundleVersionKey in Xcode. | | device_os | Device Operating System Version. Example: 80 = Chrome 80, 9 = Android 9 | | device_type | Device Operating System Type | | device_model | Device Hardware String Code. Example: Mobile Web Subscribers will have Linux armv | | ad_id | Based on the Google Advertising Id for Android, identifierForVendor for iOS. OptedOut means user turned off Advertising tracking on the device. | | tags | Current OneSignal Data Tags on the device. | | last_active | Date and time the user last opened the mobile app or visited the site. | | playtime | Total amount of time in seconds the user had the mobile app open. | | amount_spent | Mobile only - amount spent in USD on In-App Purchases. | | created_at | Date and time the device record was created in OneSignal. Mobile - first time they opened the app with OneSignal SDK. Web - first time the user subscribed to the site. | | invalid_identifier | t = unsubscribed, f = subscibed | | badge_count | Current number of badges on the device | - Extra Columns: | Field | Details | | --- | --- | | external_user_id | Your User Id set on the device | | notification_types | Notification types | | location | Location points (Latitude and Longitude) set on the device. | | country | Country code | | rooted | Android device rooted or not | | ip | IP Address of the device if being tracked. See Handling Personal Data. | | web_auth | Web Only authorization key. | | web_p256 | Web Only p256 key. |

Parameters

Name	Type	Description	Required	Notes
app_id	String	The app ID that you want to export devices from	[required]
export_subscriptions_request_body	Option<ExportSubscriptionsRequestBody>

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

get_aliases

crate::models::UserIdentityBody get_aliases(app_id, alias_label, alias_id)

Lists all Aliases for the User identified by (:alias_label, :alias_id).

Parameters

Name	Type	Required
app_id	String	[required]
alias_label	String	[required]
alias_id	String	[required]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_aliases_by_subscription

crate::models::UserIdentityBody get_aliases_by_subscription(app_id, subscription_id)

Lists all Aliases for the User identified by :subscription_id.

Parameters

Name	Type	Description	Required	Notes
app_id	String		[required]
subscription_id	String		[required]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_app

crate::models::App get_app(app_id) View an app

View the details of a single OneSignal app

Parameters

Name	Type	Description	Required	Notes
app_id	String	An app id	[required]

Return type

crate::models::App

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_apps

Veccrate::models::App get_apps() View apps

View the details of all of your current OneSignal apps

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::App

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

crate::models::NotificationWithMeta

get_notification

crate::models::NotificationWithMeta get_notification(app_id, notification_id) View notification

View the details of a single notification and outcomes associated with it

Parameters

Name	Type	Description	Required	Notes
app_id	String		[required]
notification_id	String		[required]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

crate::models::NotificationHistorySuccessResponse

get_notification_history

crate::models::NotificationHistorySuccessResponse get_notification_history(notification_id, get_notification_history_request_body) Notification History

-> View the devices sent a message - OneSignal Paid Plan Required This method will return all devices that were sent the given notification_id of an Email or Push Notification if used within 7 days of the date sent. After 7 days of the sending date, the message history data will be unavailable. After a successful response is received, the destination url may be polled until the file becomes available. Most exports are done in ~1-3 minutes, so setting a poll interval of 10 seconds should be adequate. For use cases that are not meant to be consumed by a script, an email will be sent to the supplied email address. 🚧 Requirements A OneSignal Paid Plan. Turn on Send History via OneSignal API in Settings -> Analytics. Cannot get data before this was turned on. Must be called within 7 days after sending the message. Messages targeting under 1000 recipients will not have "sent" events recorded, but will show "clicked" events. Requires your OneSignal App's REST API Key, available in Keys & IDs.

Parameters

Name	Type	Description	Required	Notes
notification_id	String	The "id" of the message found in the Notification object	[required]
get_notification_history_request_body	GetNotificationHistoryRequestBody		[required]

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

crate::models::NotificationSlice

get_notifications

crate::models::NotificationSlice get_notifications(app_id, limit, offset, kind) View notifications

View the details of multiple notifications

Parameters

Name	Type	Description	Required
app_id	String	The app ID that you want to view notifications from	[required]
limit	Option<i32>	How many notifications to return. Max is 50. Default is 50.
offset	Option<i32>	Page offset. Default is 0. Results are sorted by queued_at in descending order. queued_at is a representation of the time that the notification was queued at.
kind	Option<i32>	Kind of notifications returned: * unset - All notification types (default) * `0` - Dashboard only * `1` - API only * `3` - Automated only

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

crate::models::OutcomesData

get_outcomes

crate::models::OutcomesData get_outcomes(app_id, outcome_names, outcome_names2, outcome_time_range, outcome_platforms, outcome_attribution) View Outcomes

View the details of all the outcomes associated with your app 🚧 Requires Authentication Key Requires your OneSignal App's REST API Key, available in Keys & IDs. 🚧 Outcome Data Limitations Outcomes are only accessible for around 30 days before deleted from our servers. You will need to export this data every month if you want to keep it.

Parameters

Name	Type	Description	Required
app_id	String	The OneSignal App ID for your app. Available in Keys & IDs.	[required]
outcome_names	String	Required Comma-separated list of names and the value (sum/count) for the returned outcome data. Note: Clicks only support count aggregation. For out-of-the-box OneSignal outcomes such as click and session duration, please use the "os" prefix with two underscores. For other outcomes, please use the name specified by the user. Example:os__session_duration.count,os__click.count,CustomOutcomeName.sum	[required]
outcome_names2	Option<String>	Optional If outcome names contain any commas, then please specify only one value at a time. Example: outcome_names[]=os__click.count&outcome_names[]=Sales, Purchase.count where "Sales, Purchase" is the custom outcomes with a comma in the name.
outcome_time_range	Option<String>	Optional Time range for the returned data. The values can be 1h (for the last 1 hour data), 1d (for the last 1 day data), or 1mo (for the last 1 month data). Default is 1h if the parameter is omitted.
outcome_platforms	Option<String>	Optional Platform id. Refer device's platform ids for values. Example: outcome_platform=0 for iOS outcome_platform=7,8 for Safari and Firefox Default is data from all platforms if the parameter is omitted.
outcome_attribution	Option<String>	Optional Attribution type for the outcomes. The values can be direct or influenced or unattributed. Example: outcome_attribution=direct Default is total (returns direct+influenced+unattributed) if the parameter is omitted.

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

crate::models::GetSegmentsSuccessResponse

get_segments

crate::models::GetSegmentsSuccessResponse get_segments(app_id, offset, limit) Get Segments

Returns an array of segments from an app.

Parameters

Name	Type	Description	Required
app_id	String	The OneSignal App ID for your app. Available in Keys & IDs.	[required]
offset	Option<i32>	Segments are listed in ascending order of created_at date. offset will omit that number of segments from the beginning of the list. Eg offset 5, will remove the 5 earliest created Segments.
limit	Option<i32>	The amount of Segments in the response. Maximum 300.

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_user

crate::models::User get_user(app_id, alias_label, alias_id)

Returns the User’s properties, Aliases, and Subscriptions.

Parameters

Name	Type	Required
app_id	String	[required]
alias_label	String	[required]
alias_id	String	[required]

Return type

crate::models::User

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

crate::models::CreateApiKeyResponse

rotate_api_key

crate::models::CreateApiKeyResponse rotate_api_key(app_id, token_id) Rotate API key

Rotate a Rich Authentication Token (App API Key) for a OneSignal app. Rotating a key revokes the current token and generates a new one under the same configuration—ideal when a token is lost or compromised but you don’t want to recreate and reconfigure it from scratch.

Parameters

Name	Type	Description	Required	Notes
app_id	String		[required]
token_id	String		[required]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

crate::models::StartLiveActivitySuccessResponse

start_live_activity

crate::models::StartLiveActivitySuccessResponse start_live_activity(app_id, activity_type, start_live_activity_request) Start Live Activity

Remotely start a Live Activity on iOS devices via OneSignal’s REST API.

Parameters

Name	Type	Description	Required
app_id	String	Your OneSignal App ID in UUID v4 format.	[required]
activity_type	String	The name of the Live Activity defined in your app. This should match the attributes struct used in your app's Live Activity implementation.	[required]
start_live_activity_request	StartLiveActivityRequest		[required]

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

transfer_subscription

crate::models::UserIdentityBody transfer_subscription(app_id, subscription_id, transfer_subscription_request_body)

Transfers this Subscription to the User identified by the identity in the payload.

Parameters

Name	Type	Required
app_id	String	[required]
subscription_id	String	[required]
transfer_subscription_request_body	TransferSubscriptionRequestBody	[required]

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

unsubscribe_email_with_token

crate::models::GenericSuccessBoolResponse unsubscribe_email_with_token(app_id, notification_id, token) Unsubscribe with token

Unsubscribe an email with a token when using your own custom email unsubscribe landing page

Parameters

Name	Type	Description	Required
app_id	String	The OneSignal App ID for your app. Available in Keys & IDs.	[required]
notification_id	String	The id of the message found in the creation notification POST response, View Notifications GET response, or URL within the Message Report.	[required]
token	String	The unsubscribe token that is generated via liquid syntax in {{subscription.unsubscribe_token}} when personalizing an email.	[required]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

update_api_key

serde_json::Value update_api_key(app_id, token_id, update_api_key_request) Update API key

Update a Rich Authentication Token (App API Key) for a OneSignal app.

Parameters

Name	Type	Required
app_id	String	[required]
token_id	String	[required]
update_api_key_request	UpdateApiKeyRequest	[required]

Return type

serde_json::Value

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

update_app

crate::models::App update_app(app_id, app) Update an app

Updates the name or configuration settings of an existing OneSignal app

Parameters

Name	Type	Description	Required	Notes
app_id	String	An app id	[required]
app	App		[required]

Return type

crate::models::App

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

crate::models::UpdateLiveActivitySuccessResponse

update_live_activity

crate::models::UpdateLiveActivitySuccessResponse update_live_activity(app_id, activity_id, update_live_activity_request) Update a Live Activity via Push

Updates a specified live activity.

Parameters

Name	Type	Description	Required
app_id	String	The OneSignal App ID for your app. Available in Keys & IDs.	[required]
activity_id	String	Live Activity record ID	[required]
update_live_activity_request	UpdateLiveActivityRequest		[required]

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

update_subscription

update_subscription(app_id, subscription_id, subscription_body)

Updates an existing Subscription’s properties.

Parameters

Name	Type	Required
app_id	String	[required]
subscription_id	String	[required]
subscription_body	SubscriptionBody	[required]

Return type

(empty response body)

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

update_subscription_by_token

serde_json::Value update_subscription_by_token(app_id, token_type, token, subscription_body) Update subscription by token

Update properties on an existing OneSignal subscription using its token.

Parameters

Name	Type	Description	Required
app_id	String	Your OneSignal App ID in UUID v4 format.	[required]
token_type	String	The type of token to use when looking up the subscription. See Subscription Types.	[required]
token	String	The value of the token to lookup by (e.g., email address, phone number).	[required]
subscription_body	SubscriptionBody		[required]

Return type

serde_json::Value

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

update_template

crate::models::TemplateResource update_template(template_id, app_id, update_template_request) Update template

Update an existing template.

Parameters

Name	Type	Required
template_id	String	[required]
app_id	String	[required]
update_template_request	UpdateTemplateRequest	[required]

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

crate::models::PropertiesBody

update_user

crate::models::PropertiesBody update_user(app_id, alias_label, alias_id, update_user_request)

Updates an existing User’s properties.

Parameters

Name	Type	Required
app_id	String	[required]
alias_label	String	[required]
alias_id	String	[required]
update_user_request	UpdateUserRequest	[required]

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

crate::models::ApiKeyTokensListResponse

view_api_keys

crate::models::ApiKeyTokensListResponse view_api_keys(app_id) View API keys

View the details of all of your current app API keys (Rich Authentication Token) for a single OneSignal app.

Parameters

Name	Type	Description	Required	Notes
app_id	String		[required]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

view_template

crate::models::TemplateResource view_template(template_id, app_id) View template

Fetch a single template by id.

Parameters

Name	Type	Description	Required	Notes
template_id	String		[required]
app_id	String		[required]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

crate::models::TemplatesListResponse

view_templates

crate::models::TemplatesListResponse view_templates(app_id, limit, offset, channel) View templates

List templates for an app.

Parameters

Name	Type	Description	Required	Notes
app_id	String	Your OneSignal App ID in UUID v4 format.	[required]
limit	Option<i32>	Maximum number of templates. Default and max is 50.		[default to 50]
offset	Option<i32>	Pagination offset.		[default to 0]
channel	Option<String>	Filter by delivery channel.

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json