User Model beta release
⚠️ This release includes breaking changes. Please test before using in production.
Changes
API Endpoints
Added Endpoints
- CreateAlias
PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
- CreateAliasBySubscription
PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity
- CreateSegment
POST /apps/{app_id}/segments
- DeleteSegment
DELETE /apps/{app_id}/segments/{segment_id}
- ExportSubscriptions
POST /players/csv_export?app_id={app_id}
- GetAliases
GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
- GetAliasesBySubscription
GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity
- GetSegments
GET /apps/{app_id}/segments
- GetUser
GET /apps/{app_id}/users/by/{alias_label}/{alias_id}
- UnsubscribeEmailWithToken
POST /apps/{app_id}/notifications/{notification_id}/unsubscribe
Modified Endpoints
- CreateSegments → CreateSegment (endpoint and method signature updated)
- DeleteSegments → DeleteSegment (endpoint and method signature updated)
Removed Endpoints
- BeginLiveActivity
POST /apps/{app_id}/live_activities/{activity_id}/token
- CreatePlayer
POST /players
- DeletePlayer
DELETE /players/{player_id}
- DeleteSegments
DELETE /apps/{app_id}/segments/{segment_id}
- EndLiveActivity
DELETE /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id}
- ExportPlayers
POST /players/csv_export?app_id={app_id}
- FetchAliases
GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity
- FetchUser
GET /apps/{app_id}/users/by/{alias_label}/{alias_id}
- FetchUserIdentity
GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
- GetEligibleIams
GET /apps/{app_id}/subscriptions/{subscription_id}/iams
- GetPlayer
GET /players/{player_id}
- GetPlayers
GET /players
- IdentifyUserByAlias
PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
- IdentifyUserBySubscriptionId
PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity
- UpdatePlayer
PUT /players/{player_id}
- UpdatePlayerTags
PUT /apps/{app_id}/users/{external_user_id}
Models
Added Models
ExportSubscriptionsRequestBody
ExportSubscriptionsSuccessResponse
FilterExpression
GenericSuccessBoolResponse
GetNotificationHistoryRequestBody
GetSegmentsSuccessResponse
LanguageStringMap
RateLimitError
SegmentData
Subscription
SubscriptionBody
SubscriptionNotificationTarget
UserIdentityBody
WebButton
Modified Models
CreateSegments → CreateSegment (model and docs reference updated)
DeleteSegments → DeleteSegment (model and docs reference updated)
PropertiesBody (added)
PropertiesDeltas (added)
PropertiesObject (added)
Segment (added SegmentData reference)
Notification (updated fields)
NotificationAllOf (updated fields)
NotificationHistorySuccessResponse (updated fields)
PlatformDeliveryData (updated fields)
PlatformDeliveryDataEmailAllOf (updated fields)
PlatformDeliveryDataSmsAllOf (updated fields)
TransferSubscriptionRequestBody (updated fields)
UpdateLiveActivityRequest (updated fields)
UpdateLiveActivitySuccessResponse (updated fields)
UpdateUserRequest (updated fields)
User (updated fields)
Removed Models
BeginLiveActivityRequest
CancelNotificationSuccessResponse
CreatePlayerSuccessResponse
CreateSubscriptionRequestBody
DeletePlayerNotFoundResponse
DeletePlayerSuccessResponse
DeleteSegmentNotFoundResponse
DeleteSegmentSuccessResponse
ExportPlayersRequestBody
ExportPlayersSuccessResponse
FilterExpressions
GenericErrorErrorsInner
GetNotificationRequestBody
InlineResponse200
InlineResponse2003
InlineResponse201
InlineResponse202
InvalidIdentifierError
Notification200Errors
Player
PlayerNotificationTarget
PlayerNotificationTargetIncludeAliases
PlayerSlice
RateLimiterError
StringMap
SubscriptionObject
UpdatePlayerSuccessResponse
UpdatePlayerTagsRequestBody
UpdatePlayerTagsSuccessResponse
UpdateSubscriptionRequestBody
UserIdentityRequestBody
UserIdentityResponse
UserSubscriptionOptions