v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Upgrade profile action

This endpoint allows you to log customer interactions with an upgrade profile, such as banner views, drawer views, and dismissals. These logs are used for tracking upgrade offer performance and analytics.

post/2023-10/subscription/{subscriptionId}/upgrade/log

Path parameters

subscriptionIdinteger required

The unique identifier of the subscription in Loop.

Query parameters

profileIdstring required

Unique identifier of the upgrade profile for which the action should be logged.

viewType'BANNER_VIEW' | 'DETAILED_VIEW' | 'DISMISSED' required

Type of customer interaction to log for the upgrade profile.

Response

200

successboolean

Indicates whether the upgrade profile action was logged successfully.

messagestring

Provides additional context about the result of the request.

datastring

Contains response data for the request. This is returned as null when no additional data is available.

codestring

Response status code returned by Loop. For a successful request, this is usually SUCCESS.

pageInfostring

Pagination information for the response. This is null when pagination is not applicable.

Example response

{
  "success": true,
  "message": "Action logged successfully",
  "code": "SUCCESS"
}