> ## 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. # Update the coupon pop-up > Saves the pop-up whole. Switched off, it is saved as it is, finished or not. Switched on, it needs a title and a coupon buyers can use today. Needs the `coupons.write` permission (Change Coupons). ## OpenAPI ````yaml /api-reference/openapi.json put /stores/{storeId}/coupon-popup 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}/coupon-popup: put: tags: - Coupon pop-up summary: Update the coupon pop-up description: >- Saves the pop-up whole. Switched off, it is saved as it is, finished or not. Switched on, it needs a title and a coupon buyers can use today. Needs the `coupons.write` permission (Change Coupons). operationId: couponPopup.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 the storefront shows it. default: false couponId: type: string description: The coupon it hands out. title: type: string description: Its heading, up to 80 characters. message: type: string description: The line under the heading, up to 240 characters. buttonText: type: string description: What its button says, up to 30 characters. opens: type: string description: After a wait, or when the visitor looks like leaving. enum: - delay - leave default: delay delaySeconds: type: integer description: >- How long the wait is when `opens` is `delay`: 0 to 120 seconds. default: 5 frequency: type: string description: >- How often one visitor sees it: on every page, once a visit, or once in that browser. enum: - page - visit - browser default: visit 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 couponId: type: string coupon: type: object properties: id: type: string code: type: string discountType: type: string value: type: integer minSubtotal: type: integer expiresAt: nullable: true appliesTo: type: string unusable: type: string pausedBySale: type: boolean title: type: string message: type: string buttonText: type: string opens: type: string delaySeconds: type: integer frequency: type: string updatedAt: type: string example: success: true message: null code: null data: enabled: false couponId: e6ffacf4-0cef-460d-9a1d-a17c6f295a29 coupon: id: e6ffacf4-0cef-460d-9a1d-a17c6f295a29 code: WELCOME10 discountType: percent value: 15 minSubtotal: 0 expiresAt: null appliesTo: all unusable: '' pausedBySale: false title: Ten percent off your first order message: Use it at checkout. buttonText: Copy code opens: delay delaySeconds: 5 frequency: visit updatedAt: '2026-10-22T16:20:18.813Z' '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.couponPopup.update(); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->couponPopup->update(); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.couponPopup.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.