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

# Change Win-Back

> Changes the settings named and keeps the rest. Win-Back writes only to subscribers: buyers who ticked "Email me news and offers" at checkout on an order they paid, and have not said no since. The first email goes the set number of days after a buyer's last completed order, if they have not ordered since; the second, days after the first, carries a coupon made for that buyer, good for 7 days. A buyer with a dispute on record is not written to. Switching it on also switches on asking at checkout, and `meta.askingTurnedOn` says so. An empty subject is the email's own.

Needs the `marketing.write` permission (Change Email Marketing).



## OpenAPI

````yaml /api-reference/openapi.json put /stores/{storeId}/win-back
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Blacklist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/win-back:
    put:
      tags:
        - Email Marketing
      summary: Change Win-Back
      description: >-
        Changes the settings named and keeps the rest. Win-Back writes only to
        subscribers: buyers who ticked "Email me news and offers" at checkout on
        an order they paid, and have not said no since. The first email goes the
        set number of days after a buyer's last completed order, if they have
        not ordered since; the second, days after the first, carries a coupon
        made for that buyer, good for 7 days. A buyer with a dispute on record
        is not written to. Switching it on also switches on asking at checkout,
        and `meta.askingTurnedOn` says so. An empty subject is the email's own.


        Needs the `marketing.write` permission (Change Email Marketing).
      operationId: winBack.update
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Whether Win-Back writes to anybody.
                firstOn:
                  type: boolean
                  description: Whether the first email is sent.
                firstDays:
                  type: integer
                  description: >-
                    Days after a buyer's last order. One of 14, 21, 30, 45, 60,
                    90.
                  example: 30
                firstSubject:
                  type: string
                  description: Its subject, up to 150 characters.
                secondOn:
                  type: boolean
                  description: Whether the second email is sent.
                secondDays:
                  type: integer
                  description: Days after the first. One of 3, 7, 14, 21, 30.
                  example: 14
                secondSubject:
                  type: string
                  description: Its subject, up to 150 characters.
                secondPercent:
                  type: integer
                  description: >-
                    The percent off its coupon. One of 0, 5, 10, 15, 20, 25. 0
                    sends it with no coupon.
                  example: 15
                audience:
                  type: string
                  description: >-
                    Who is written to: empty for every subscriber, `vip`, or the
                    ID of one of the store's tags.
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                      firstOn:
                        type: boolean
                      firstDays:
                        type: integer
                      firstSubject:
                        type: string
                      secondOn:
                        type: boolean
                      secondDays:
                        type: integer
                      secondSubject:
                        type: string
                      secondPercent:
                        type: integer
                      audience:
                        type: string
                  meta:
                    type: object
                    properties:
                      asking:
                        type: boolean
                      askingTurnedOn:
                        type: boolean
              example:
                success: true
                message: null
                code: null
                data:
                  enabled: true
                  firstOn: true
                  firstDays: 30
                  firstSubject: ''
                  secondOn: true
                  secondDays: 14
                  secondSubject: ''
                  secondPercent: 15
                  audience: ''
                meta:
                  asking: true
                  askingTurnedOn: true
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Refused'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const result = await shoply.winBack.update();
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $result = $shoply->winBack->update();
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.winBack.update()
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        A word of your own for this one change, up to 180 letters, digits, dots,
        dashes, underscores and colons. Sent again with the same key, the
        request is not carried out twice: the first answer comes back, with
        `Idempotent-Replay: true`.
      schema:
        type: string
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    Refused:
      description: >-
        The request was understood and not carried out. `validation_failed` says
        what is wrong with each field under `errors`; other codes are the
        route's own.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.