> ## 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 dispute settings

> Changes the settings named and keeps the rest. Accepting small ones and submitting before the deadline are for disputes answered from Shoply (Stripe's, Revolut's, Adyen's, and PayPal's with API keys), and run every few minutes: a dispute under `acceptUnder` that nobody has started an answer for is accepted, and with a day left an answer is submitted as it stands, or where there is none, only when the buyer opened their order or took a file from the address they paid from. Nothing over `askAbove` is sent or accepted by itself where `askAboveOn` is on.

Needs the `disputes.write` permission (Answer Disputes).



## OpenAPI

````yaml /api-reference/openapi.json put /stores/{storeId}/dispute-settings
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}/dispute-settings:
    put:
      tags:
        - Disputes
      summary: Change dispute settings
      description: >-
        Changes the settings named and keeps the rest. Accepting small ones and
        submitting before the deadline are for disputes answered from Shoply
        (Stripe's, Revolut's, Adyen's, and PayPal's with API keys), and run
        every few minutes: a dispute under `acceptUnder` that nobody has started
        an answer for is accepted, and with a day left an answer is submitted as
        it stands, or where there is none, only when the buyer opened their
        order or took a file from the address they paid from. Nothing over
        `askAbove` is sent or accepted by itself where `askAboveOn` is on.


        Needs the `disputes.write` permission (Answer Disputes).
      operationId: disputes.updateSettings
      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:
                blacklist:
                  type: boolean
                  description: >-
                    Blacklist the buyer's email and addresses when a dispute
                    opens.
                takeBackAccess:
                  type: boolean
                  description: >-
                    Hide what the order delivered from its buyer while a dispute
                    is open, shown again if it is won.
                acceptSmall:
                  type: boolean
                  description: >-
                    Accept a dispute answered from Shoply under `acceptUnder`
                    rather than fight it.
                acceptUnder:
                  type: number
                  description: The amount, above 0.
                  example: 10
                autoSubmit:
                  type: boolean
                  description: >-
                    Submit the answer of a dispute answered from Shoply with a
                    day left.
                askAboveOn:
                  type: boolean
                  description: Never send or accept one over `askAbove` by itself.
                askAbove:
                  type: number
                  description: The amount, above 0, up to 1,000,000.
                  example: 100
                emailOpened:
                  type: boolean
                  description: Email the store when one opens, with its deadline.
                emailClosed:
                  type: boolean
                  description: Email the store how one ended.
                discord:
                  type: boolean
                  description: >-
                    Post both to the store's Discord. Needs a webhook in its
                    notification settings.
      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:
                      blacklist:
                        type: boolean
                      takeBackAccess:
                        type: boolean
                      acceptSmall:
                        type: boolean
                      acceptUnder:
                        type: integer
                      autoSubmit:
                        type: boolean
                      askAboveOn:
                        type: boolean
                      askAbove:
                        type: integer
                      emailOpened:
                        type: boolean
                      emailClosed:
                        type: boolean
                      discord:
                        type: boolean
                      currency:
                        type: string
              example:
                success: true
                message: null
                code: null
                data:
                  blacklist: true
                  takeBackAccess: true
                  acceptSmall: true
                  acceptUnder: 10
                  autoSubmit: false
                  askAboveOn: false
                  askAbove: 100
                  emailOpened: true
                  emailClosed: true
                  discord: false
                  currency: USD
        '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.disputes.updateSettings();
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

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

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

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.disputes.updateSettings()
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.