v5.4.0

5.4.0 (2026-04-17)

Features

• add v5.4.0 package updates (#42) (6832bbd)

v5.3.0

Channels: stable, current

5.3.0 (2026-03-24)

Features

• add Huawei and email_reply_to_address parameters to Notification (#37) (b5b483f)

5.3.0-beta1

Channels: Beta

Features

• adds support for the Custom Events endpoint
• adds support for the Start Live Activity endpoint
• adds support for the Template endpoints
• adds support for the Update Subscription by token endpoint
• adds support for the Authentication endpoints

5.2.1-beta1

Features

• add canceled boolean to NotificationWithMeta schema

5.2.0-beta1

Features

• add disable_email_click_tracking Notification API parameter

5.1.0-beta1

User Model beta release

⚠️ This release includes breaking changes. Please test before using in production.

Changes

Auth Updates

• ⚠️ Replace app_key_token on apis::configuration::Configuration with rest_api_key_token
• ⚠️ Replace user_key_token on apis::configuration::Configuration with organization_api_key_token

API Endpoints

Added Endpoints

• PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity (create_alias)
• PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity (create_alias_by_subscription)
• POST /players/csv_export?app_id={app_id} (export_subscriptions)
• GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity (get_aliases)
• GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity (get_aliases_by_subscription)
• GET /apps/{app_id}/segments (get_segments)
• GET /apps/{app_id}/users/by/{alias_label}/{alias_id} (get_user)
• POST /apps/{app_id}/notifications/{notification_id}/unsubscribe (unsubscribe_email_with_token)

Modified Endpoints

• POST /apps/{app_id}/segments (create_segments → create_segment)
• DELETE /apps/{app_id}/segments/{segment_id} (delete_segments → delete_segment)

Removed Endpoints

• POST /apps/{app_id}/live_activities/{activity_id}/token (begin_live_activity)
• POST /players (create_player)
• DELETE /players/{player_id} (delete_player)
• DELETE /apps/{app_id}/segments/{segment_id} (delete_segments; replaced by delete_segment)
• DELETE /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id} (end_live_activity)
• POST /players/csv_export?app_id={app_id} (export_players; replaced by export_subscriptions)
• GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity (fetch_aliases; replaced by get_aliases_by_subscription)
• GET /apps/{app_id}/users/by/{alias_label}/{alias_id} (fetch_user; replaced by get_user)
• GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity (fetch_user_identity; replaced by get_aliases)
• GET /apps/{app_id}/subscriptions/{subscription_id}/iams (get_eligible_iams)
• GET /players/{player_id} (get_player)
• GET /players (get_players)
• PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity (identify_user_by_alias; replaced by create_alias)
• PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity (identify_user_by_subscription_id; replaced by create_alias_by_subscription)
• PUT /players/{player_id} (update_player)
• PUT /apps/{app_id}/users/{external_user_id} (update_player_tags)

---

Models

Added Models

• ExportSubscriptionsRequestBody
• ExportSubscriptionsSuccessResponse
• FilterExpression
• GenericSuccessBoolResponse
• GetNotificationHistoryRequestBody
• GetSegmentsSuccessResponse
• LanguageStringMap
• PropertiesBody
• RateLimitError
• SegmentData
• Subscription
• SubscriptionBody
• SubscriptionNotificationTarget
• UserIdentityBody
• WebButton

Modified Models

• RateLimiterError → RateLimitError (renamed)
• FilterExpressions → FilterExpression (replaced/renamed)
• SubscriptionObject → Subscription (replaced/renamed)

Removed Models

• BeginLiveActivityRequest
• CancelNotificationSuccessResponse
• CreatePlayerSuccessResponse
• CreateSubscriptionRequestBody
• DeletePlayerNotFoundResponse
• DeletePlayerSuccessResponse
• DeleteSegmentNotFoundResponse
• DeleteSegmentSuccessResponse
• ExportPlayersRequestBody
• ExportPlayersSuccessResponse
• FilterExpressions (replaced by FilterExpression)
• GenericErrorErrorsInner
• GetNotificationRequestBody
• InlineResponse200
• InlineResponse2003
• InlineResponse201
• InlineResponse202
• InvalidIdentifierError
• Notification200Errors
• Player
• PlayerNotificationTarget
• PlayerNotificationTargetIncludeAliases
• PlayerSlice
• RateLimiterError (replaced by RateLimitError)
• StringMap
• SubscriptionObject (replaced by Subscription)
• UpdatePlayerSuccessResponse
• UpdatePlayerTagsRequestBody
• UpdatePlayerTagsSuccessResponse
• UpdateSubscriptionRequestBody
• UserIdentityRequestBody
• UserIdentityResponse
• UserSubscriptionOptions

2.2.1

Channels: Stable

Fixes

• set notification_type to be type i32, instead of f32, on SubscriptionObject

2.2.0

Features

• deprecate external_id in favor of idempotency_key as basenotification field

Fixes

• favor Key auth prefix over Bearer

2.1.0

Features

• Add authMethod for delete_user

Fixes

• Set base URL to https://api.onesignal.com/