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

# Rename design

> Use this endpoint to rename a swag design. The updated design is returned.

###### Request parameters
- `designId` - required design UUID
- `Snappy-Account-Id` header - required account identifier
- `name` - required body field. The new name, trimmed, 1-100 characters

###### Please note
- Only `name` can be changed. Any other body field (for example `imprint`) is rejected with `400`.
- Design names are unique within the company. Renaming a design to an existing name responds with `409`.
- Designs that are still being generated are not visible and respond with `404`.

#### Permissions
- Requires: `swag:designs:update`



## OpenAPI

````yaml patch /v3/swag/designs/{designId}
openapi: 3.0.3
info:
  title: Snappy Public API v3
  version: 3.0.0
  contact:
    name: Snappy Support
    email: info@snappy.com
  description: >-
    Welcome to the Snappy API reference documentation!

    You can use this API to integrate with Snappy and spread smiles to your
    employees/clients/customers and much more.

    So let's get started!
servers:
  - url: https://api.snappy.com/public-api
    description: Base API URL
  - url: https://mtls-api.snappy.com/public-api
    description: >-
      ## mTLS URL

      You can also use mTLS to enhance your API security. To get your specific
      certificates please contact our support.

      Once you configure the certificated correctly, you need to also update
      endpoints to use the following secure api base URL:
security: []
tags:
  - name: Products
    description: >-
      Use these endpoints to retrieve products and tags for building catalog and
      browse experiences in your UI.
  - name: Collections
    description: >-
      Use these endpoints to retrieve products within curated collections for
      marketplace and browse experiences.
  - name: Variants
    description: >-
      Use these endpoints to retrieve variants, variant pricing, and country
      availability for orderable product SKUs.
  - name: Billing Methods
    description: >-
      A **Billing Method** is the funding source attached to an **Account** -
      for example, a Purchase Order (PO), Invoice, Prepay deposit, or Credit
      Card. Use these endpoints to retrieve billing method details such as
      remaining balance, status, and expiration.
  - name: Accounts
    description: >-
      An **Account** is a sub-entity within a **Company**, used to organize
      campaigns and gift sends. Use these endpoints to list, retrieve, and
      create accounts.
  - name: API Keys
    description: >-
      Use these endpoints to manage API keys for programmatic access. Key
      management requires company owner privileges.
  - name: Orders
    description: >-
      Use these endpoints to place, retrieve, cancel, and validate orders and
      shipping addresses.
  - name: Digital cards
    description: Use these endpoints to create, retrieve, and access digital cards.
  - name: Base products
    description: Browse swag product templates and their available variants.
  - name: Base variants
    description: Retrieve individual orderable variants of swag product templates.
  - name: Designs
    description: >-
      A **Design** is a logo-based swag design that can be applied to base
      products. Use these endpoints to retrieve and rename your designs.
paths:
  /v3/swag/designs/{designId}:
    patch:
      tags:
        - Designs
      summary: Rename design
      description: >-
        Use this endpoint to rename a swag design. The updated design is
        returned.


        ###### Request parameters

        - `designId` - required design UUID

        - `Snappy-Account-Id` header - required account identifier

        - `name` - required body field. The new name, trimmed, 1-100 characters


        ###### Please note

        - Only `name` can be changed. Any other body field (for example
        `imprint`) is rejected with `400`.

        - Design names are unique within the company. Renaming a design to an
        existing name responds with `409`.

        - Designs that are still being generated are not visible and respond
        with `404`.


        #### Permissions

        - Requires: `swag:designs:update`
      parameters:
        - schema:
            type: string
            format: uuid
            description: Design UUID.
            example: 3f1c2a9e-8b7d-4c1e-9f0a-2b3c4d5e6f70
          required: true
          description: Design UUID.
          name: designId
          in: path
        - schema:
            type: string
            minLength: 1
            description: Required. Account identifier.
            example: acc123456
          required: true
          description: Required. Account identifier.
          name: snappy-account-id
          in: header
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchDesignV3Body'
      responses:
        '200':
          description: Updated design.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchDesignV3Response'
        '400':
          description: Bad Request - Invalid path parameter, header or body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV3'
              example:
                message: Request validation failed.
                errorCode: 400_PBLC_001
                errors:
                  - errorCode: 400_PBLC_002
                    message: 'Too small: expected string to have >=1 characters'
                    path: body.name
        '404':
          description: Not Found - Design or account does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV3'
              example:
                message: Design not found.
                errorCode: 404_DSGN_001
        '409':
          description: Conflict - Another design in the company already has this name.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV3'
              example:
                message: Design name already exists.
                errorCode: 409_DSGN_001
      security:
        - ApiKeyAuthentication: []
components:
  schemas:
    PatchDesignV3Body:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 100
          description: >-
            New design name. Trimmed, 1-100 characters. Must be unique within
            the company.
          example: Acme Summit 2026 - Primary
      required:
        - name
      additionalProperties: false
      description: Request body to rename a design. Only `name` is accepted.
      example:
        name: Acme Summit 2026 - Primary
    PatchDesignV3Response:
      type: object
      properties:
        data:
          allOf:
            - $ref: '#/components/schemas/DesignV3'
            - description: Updated design.
      required:
        - data
      description: Updated design, in the same shape as `GET /v3/swag/designs/{designId}`.
    ErrorResponseV3:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message.
          example: Product not found.
        errorCode:
          type: string
          description: Structured error code.
          example: 404_PROD_001
        errors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
                example: Product with id 'q1w2e3r4t5' was not found
              path:
                type: string
                description: Dot-separated path to the field that caused the error.
                example: pathParameters.productId
              errorCode:
                type: string
                example: 404_PROD_001
            required:
              - message
              - path
          description: Optional field-level error details.
      required:
        - message
        - errorCode
      description: Standard v3 error envelope.
    DesignV3:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Design UUID.
          example: 3f1c2a9e-8b7d-4c1e-9f0a-2b3c4d5e6f70
        name:
          type: string
          description: Design name.
          example: Acme Summit 2026 - Primary
        imprint:
          type: string
          nullable: true
          description: >-
            URL of the logo printed on the design items, or `null` when the
            design has no logo.
          example: https://image.snappy.com/9f4e84f84d94
      required:
        - id
        - name
        - imprint
      description: >-
        A swag design: a logo-based design that can be applied to swag base
        products.
  securitySchemes:
    ApiKeyAuthentication:
      type: apiKey
      in: header
      name: X-Api-Key
      description: |-
        ## Company Level Authentication

        Include your API key in the `X-Api-Key` header for every request:
        ```
        X-Api-Key: YOUR_API_KEY
        ```

````

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