Sign in

v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Subscription benefit action

This endpoint is used to log the acceptance or rejection of a subscription benefit offered to a user. It accepts the subscription benefitContentId and user decision as state inputs and logs the information into the system's database for analytics purposes.

post/2023-10/subscription/{subscriptionId}/benefitAction

Path parameters

subscriptionIdinteger required

The unique identifier for a subscription in Loop.

Request body

benefitContentIdinteger required

The unique identifier of the benefit content that was shown to the subscriber.

state'ACCEPTED' | 'REJECTED' required

Indicates whether the subscriber accepted or rejected the benefit offered during the retention flow.

Response

200

successboolean

Indicates whether the request was successfully processed.

messagestring

A human-readable message describing the result of the operation.

dataobject

Additional response data returned by the system.

codestring

Status code indicating the result of the operation.

pageInfostring

Additional metadata related to the response.

Example response

{
  "success": true,
  "message": "Benefit log added successfully",
  "code": "SUCCESS"
}