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

# Update link-type coupon

> Change a GCN coupon. Send only the fields you are changing. Requires CONTRIBUTE.



## OpenAPI

````yaml /openapi/openapi-resolver.json patch /resolver/api/v1/organizations/{organization_id}/link-type-coupons/{coupon_id}
openapi: 3.1.0
info:
  title: Resolver API
  version: 1.0.0
  description: >
    GS1 Digital Link resolution with content negotiation and linkset support.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
tags:
  - name: Resolver
    description: GS1 Digital Link resolution with content negotiation and linkset support.
  - name: Custom URLs
    description: >-
      Reusable custom-URL catalog (C-3339) — create, list, edit, and delete the
      custom redirect destinations that resolution rules point at.
  - name: Resolver Configuration
    description: >-
      Organization resolver settings and per-product resolver state (C-6273) —
      the routing timezone, whether the resolver serves a product, and its
      per-GTIN behavior controls (enhanced resolution, expiry, serial policy,
      shelf-life offset, age gate). The same audited writes the dashboard pages
      make.
  - name: Link-type sections
    description: >-
      Organization-owned GS1 link-type records (C-6272) — documents (GDTI),
      coupons (GCN) and service relations (GSRN): list, read, create, update and
      delete. The same audited writes the dashboard's Link-type sections page
      makes.
  - name: Verification
    description: >-
      Serial verification (`gs1:verificationService`) — tiered, rate-limited
      responses for serialized GTIN scans. Experimental v1; see the
      verification-service guide.
  - name: GS1 Primitives (Public)
    description: >-
      Keyless GS1 Digital Link primitives (C-4295) — parse, validate, build,
      decompress, and check-digit analysis. **No API key, no signup.** Pure
      functions over strings: no database, no network, no catalog data.
      IP-throttled and edge-cached so repeat calls cost nothing. This is the
      reference implementation the resolver itself runs on.
  - name: Resolver Custom Hostnames
    description: >-
      BYO domain (C-4058) — register a customer-owned hostname, publish the
      CNAME records, verify ownership, and serve an org's Digital Link QRs from
      its own DNS.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /resolver/api/v1/organizations/{organization_id}/link-type-coupons/{coupon_id}:
    patch:
      tags:
        - Link-type sections
      summary: Update link-type coupon
      description: >-
        Change a GCN coupon. Send only the fields you are changing. Requires
        CONTRIBUTE.
      operationId: update_link_type_coupon
      parameters:
        - in: path
          name: organization_id
          schema:
            description: UUID of the organization that owns the records.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Organization Id
            type: string
          required: true
          description: UUID of the organization that owns the records.
        - in: path
          name: coupon_id
          schema:
            description: ID of the coupon.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Coupon Id
            type: string
          required: true
          description: ID of the coupon.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkTypeCouponUpdate'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkTypeCouponOut'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '405':
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '409':
          description: Conflict
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '422':
          description: Unprocessable Content
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - CookieGatedSessionAuth: []
components:
  schemas:
    LinkTypeCouponUpdate:
      description: Payload to change a GCN coupon. Send only the fields you are changing.
      examples:
        - valid_until: '2027-03-31T23:59:00Z'
      properties:
        gcn:
          anyOf:
            - maxLength: 25
              pattern: ^[^\x00]{0,25}$
              type: string
            - type: 'null'
          description: >-
            Global Coupon Number (AI 255), 13 to 25 digits. Unique across
            Closient.
          title: Gcn
        title:
          anyOf:
            - maxLength: 255
              pattern: ^[^\x00]{0,255}$
              type: string
            - type: 'null'
          description: Display title of the coupon (max 255 characters).
          title: Title
        terms:
          anyOf:
            - pattern: ^[^\x00]{0,}$
              type: string
            - type: 'null'
          description: The coupon's terms. Send an empty string to clear them.
          title: Terms
        redemption_url:
          anyOf:
            - maxLength: 2048
              pattern: >-
                ^[Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,2039}$
              type: string
            - type: 'null'
          description: >-
            Where a shopper redeems the coupon: an absolute http(s) URL of at
            most 2048 characters. Send null to clear it.
          title: Redemption Url
        valid_from:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the coupon becomes valid. Send null to clear.
          title: Valid From
        valid_until:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the coupon stops being valid. Send null to clear.
          title: Valid Until
      title: LinkTypeCouponUpdate
      type: object
    LinkTypeCouponOut:
      description: A GCN coupon as read from the API.
      examples:
        - created: '2026-06-01T09:00:00Z'
          gcn: '9501101530003'
          id: a1b2c3d4e5f6
          modified: '2026-06-19T14:30:00Z'
          organization_id: b2c3d4e5-f678-9012-abcd-ef2345678901
          redemption_url: https://acmesnacks.com/coupons/2off
          terms: One per customer.
          title: Two dollars off
          valid_from: '2026-06-01T00:00:00Z'
          valid_until: '2026-12-31T23:59:00Z'
      properties:
        id:
          description: >-
            URL-safe 22-character shortuuid encoding of the row's UUID primary
            key. Stable across the row's lifetime; suitable for sharing in URLs,
            log lines, and external SDK clients. Accepted on input as either the
            shortuuid form or the canonical UUID form
            (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``).
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        gcn:
          description: >-
            Global Coupon Number (AI 255), 13 to 25 digits. Unique across
            Closient.
          title: Gcn
          type: string
        title:
          description: Display title of the coupon (max 255 characters).
          title: Title
          type: string
        terms:
          description: The coupon's terms; empty when none were given.
          title: Terms
          type: string
        redemption_url:
          anyOf:
            - type: string
            - type: 'null'
          description: Where a shopper redeems the coupon.
          title: Redemption Url
        valid_from:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the coupon becomes valid, or null.
          title: Valid From
        valid_until:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the coupon stops being valid, or null.
          title: Valid Until
        organization_id:
          description: UUID of the organization that owns the coupon.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Organization Id
          type: string
        created:
          description: ISO-8601 creation timestamp.
          format: date-time
          title: Created
          type: string
        modified:
          description: ISO-8601 last-modified timestamp.
          format: date-time
          title: Modified
          type: string
      required:
        - id
        - gcn
        - title
        - terms
        - organization_id
        - created
        - modified
      title: LinkTypeCouponOut
      type: object
    ErrorOut:
      description: |-
        RFC 9457 Problem Details response.

        All API errors are returned in this format with Content-Type:
        application/problem+json.
      examples:
        - detail: The requested resource was not found.
          error_code: not_found
          retryable: false
          status: 404
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Not Found
          type: https://closient.com/docs/errors/not_found
        - detail: Validation error.
          details:
            - loc:
                - body
                - name
              msg: Field required
              type: missing
          error_code: validation_error
          retryable: false
          status: 422
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Validation Error
          type: https://closient.com/docs/errors/validation_error
        - detail: Rate limit exceeded. Please try again later.
          error_code: rate_limited
          retry_after: 31
          retryable: true
          status: 429
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Rate Limited
          type: https://closient.com/docs/errors/rate_limited
      properties:
        type:
          description: URI reference identifying the error type.
          title: Type
          type: string
        title:
          description: Short human-readable summary of the error.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation of this specific occurrence.
          title: Detail
          type: string
        error_code:
          description: Machine-readable error code (e.g. not_found, unauthorized).
          title: Error Code
          type: string
        retryable:
          default: false
          description: Whether retrying the same request can succeed.
          title: Retryable
          type: boolean
        timestamp:
          description: ISO 8601 timestamp of when the error occurred.
          title: Timestamp
          type: string
        retry_after:
          anyOf:
            - type: integer
            - type: 'null'
          description: Seconds to wait before retrying (when applicable).
          title: Retry After
        owner_action_required:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the error requires account owner intervention.
          title: Owner Action Required
        details:
          description: Additional context (validation errors, etc.).
          title: Details
      required:
        - type
        - title
        - status
        - detail
        - error_code
        - timestamp
      title: ErrorOut
      type: object
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    CookieGatedSessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````

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