> ## Documentation Index
> Fetch the complete documentation index at: https://developers.appstle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create retention activity record

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



## OpenAPI

````yaml /memberships/storefront-api-swagger.json post /memberships/cp/api/customer-retention-activities
openapi: 3.0.1
info:
  description: >-
    Comprehensive API documentation for the customer-facing membership portal.
    These APIs enable customers to manage their memberships, update billing
    information, modify delivery schedules, and access their account details
    through your storefront.


    **Important**: These APIs must be called from your shop's domain (e.g.,
    https://www.myshop.com/apps/memberships/cp/api/**) and require customer
    authentication. Unauthenticated requests will return a 401 Unauthorized
    error.
  title: Storefront APIs
  version: 0.0.1
servers:
  - url: https://www.myshop.com/apps
security: []
tags:
  - description: >-
      APIs for managing Shopify delivery profiles, shipping rates, zones, and
      free shipping configuration for subscription memberships
    name: Shipping & Delivery Profiles
  - description: >-
      APIs for managing shop-level membership settings, configuration, email
      domains, webhooks, and general store information
    name: Shop Settings
  - description: >-
      APIs for integrating loyalty programs with memberships including customer
      points lookup, earn options, redeem options, and point redemption
    name: Loyalty Integration
  - description: >-
      APIs for retrieving historical discount code usage and redemption
      information for membership contracts
    name: Customer Discount History
  - description: >-
      APIs for managing membership cancellation flow settings including
      retention offers, survey questions, and cancel confirmation screens
    name: Cancellation Flow Configuration
  - description: >-
      APIs for managing membership billing attempts, recurring orders, payment
      retries, order history, and order skipping
    name: Billing & Orders
  - description: >-
      APIs for managing one-time product additions to upcoming subscription
      orders, including adding, retrieving, and removing one-off items
    name: One-Time Add-Ons
  - description: >-
      APIs for managing membership/subscription plan groups, including creating
      plans, configuring discounts, billing intervals, and assigning products to
      plans
    name: Membership Plans
  - description: >-
      APIs for managing customer retention activities including cancellation
      feedback, retention action tracking, and activity export
    name: Customer Retention
  - description: >-
      APIs for retrieving custom CSS styles applied to subscription widgets and
      customer portal for theme customization
    name: Custom CSS Styling
  - description: >-
      APIs for managing customer portal settings including UI customization,
      text labels, feature toggles, and branding options for the member
      self-service portal
    name: Customer Portal Configuration
  - description: >-
      APIs for managing membership/subscription contracts including creation,
      updates, status changes, line items, discounts, and billing operations
    name: Membership Contracts
  - description: >-
      APIs for retrieving product catalog, variants, pricing, and inventory
      information for subscription memberships
    name: Product & Inventory Data
  - description: >-
      APIs for retrieving product swap/substitution options allowing members to
      exchange subscription items based on configured swap rules and variant
      groups
    name: Product Swap Rules
  - description: APIs for managing subscription product bundles and bundle configurations.
    name: Product Bundles
  - description: APIs for managing payment methods and billing information.
    name: Customer Payment Methods
paths:
  /memberships/cp/api/customer-retention-activities:
    post:
      tags:
        - Customer Retention
      summary: Create retention activity record
      description: >-
        Records a customer retention activity such as cancellation feedback,
        retention offer acceptance, or other retention-related actions.
      operationId: createCustomerRetentionActivity
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerRetentionActivityDTO'
        required: true
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomerRetentionActivityDTO'
          description: OK
components:
  schemas:
    CustomerRetentionActivityDTO:
      properties:
        activityOn:
          format: date-time
          type: string
        additionalInfo:
          type: string
        cancellationReason:
          type: string
        contractId:
          format: int64
          type: integer
        discountApplied:
          type: string
        eventSource:
          enum:
            - PAUSE
            - CANCELLATION
          type: string
        id:
          format: int64
          type: integer
        retentionAction:
          type: string
        shop:
          type: string
      type: object

````