Create retention activity record

Records a customer retention activity such as cancellation feedback, retention offer acceptance, or other retention-related actions.

POST /memberships/cp/api/customer-retention-activities

Create retention activity record

cURL

curl --request POST \
  --url https://www.myshop.com/apps/memberships/cp/api/customer-retention-activities \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 123,
  "shop": "<string>",
  "contractId": 123,
  "activityOn": "2023-11-07T05:31:56Z",
  "retentionAction": "<string>",
  "cancellationReason": "<string>",
  "discountApplied": "<string>",
  "additionalInfo": "<string>"
}
'

200

{
  "id": 123,
  "shop": "<string>",
  "contractId": 123,
  "activityOn": "2023-11-07T05:31:56Z",
  "retentionAction": "<string>",
  "cancellationReason": "<string>",
  "discountApplied": "<string>",
  "additionalInfo": "<string>"
}

Body

application/json

id · integer<int64>

shop · string

contractId · integer<int64>

activityOn · string<date-time>

retentionAction · string

cancellationReason · string

discountApplied · string

additionalInfo · string

eventSource · enum<string>

Available options: PAUSE, CANCELLATION

Response

200 - */*

OK

id · integer<int64>

shop · string

contractId · integer<int64>

activityOn · string<date-time>

retentionAction · string

cancellationReason · string

discountApplied · string

additionalInfo · string

eventSource · enum<string>

Available options: PAUSE, CANCELLATION