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

# Unlist a currency offer

> Change the currency offer status to 'draft' removing it from public listings and preventing new purchases.



## OpenAPI

````yaml /api/openapi.json post /v2/currency-offers/{currencyOffer}/draft
openapi: 3.1.0
info:
  title: GameBoost
  version: 2.0.0
servers:
  - url: https://api.gameboost.com
    description: GameBoost API
security:
  - BearerTokenSecurityScheme: []
tags:
  - name: Games
    description: Games
  - name: Seller Breaks
    description: Seller Breaks
  - name: Payments
    description: Payments
  - name: Payouts
    description: Payouts
  - name: Account Offers
    description: Account Offers
  - name: Account Orders
    description: Account Orders
  - name: Item Offers
    description: Item Offers
  - name: Item Orders
    description: Item Orders
  - name: Currency Offers
    description: Currency Offers
  - name: Currency Orders
    description: Currency Orders
  - name: Webhooks
    description: Webhook events sent to your endpoints when specific actions occur
  - name: Gift Card Offers
    description: Gift Card Offers
  - name: Gift Card Orders
    description: Gift Card Orders
paths:
  /v2/currency-offers/{currencyOffer}/draft:
    post:
      tags:
        - Currency Offers
      summary: Unlist a currency offer
      description: >-
        Change the currency offer status to 'draft' removing it from public
        listings and preventing new purchases.
      parameters:
        - name: currencyOffer
          in: path
          description: >-
            The ID of the currency offer. Can be retrieved from the list of
            currency offers.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Currency offer action result
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CurrencyOffer'
                  message:
                    description: Action result message
                    type: string
                  action:
                    description: Action performed
                    type: string
                  previous_status:
                    description: Previous status before action
                    type: string
                    nullable: true
        '401':
          $ref: '#/components/responses/ErrorUnauthenticated'
        '403':
          $ref: '#/components/responses/ErrorForbidden'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/ErrorValidation'
        '429':
          $ref: '#/components/responses/ErrorRateLimited'
      security:
        - BearerToken: []
components:
  schemas:
    CurrencyOffer:
      description: Currency offer object representing in-game currency for sale
      type: object
      properties:
        id:
          description: Unique identifier for the currency offer
          type: integer
        uuid:
          description: Universally unique identifier for the currency offer
          type: string
        external_id:
          description: >-
            External identifier for the currency offer, used to map to your own
            system
          type: string
          nullable: true
        game:
          $ref: '#/components/schemas/GameRelation'
        currency_unit:
          $ref: '#/components/schemas/CurrencyUnit'
        title:
          description: Display name for the currency offer
          type: string
        description:
          description: Detailed description of the currency and how it will be delivered
          type: string
          nullable: true
        parameters:
          description: Game-specific parameters such as server, realm, or faction
          type: object
          nullable: true
        base_currency:
          description: >-
            Base currency used for pricing. Always `EUR` — prices are stored and
            returned in EUR regardless of the currency the seller submits.
          type: string
          example: EUR
        status:
          description: Current status of the currency offer
          enum:
            - draft
            - listed
            - archived
          type: string
        delivery_time:
          $ref: '#/components/schemas/DeliveryTime'
        delivery_instructions:
          description: >-
            Special instructions for currency delivery, provided to buyer after
            purchase
          type: string
          nullable: true
        delivery_method:
          description: Delivery method used to collect customer precheckout information
          enum:
            - none
            - username
            - login
            - trade
            - auction
            - gift
            - redeem
            - mail
          type: string
          nullable: true
        excluded_delivery_fields:
          description: Optional delivery fields disabled by the seller
          type: array
          items:
            enum:
              - username
              - server
              - login
              - password
              - platform
              - region
            type: string
        delivery_method_data:
          description: >-
            Resolved delivery method metadata and customer fields after
            game-specific label overrides
          type: object
          nullable: true
        stock:
          description: Available quantity of currency units in stock
          type: integer
        min_quantity:
          description: Minimum quantity that can be purchased in a single order
          type: integer
        price_eur:
          description: Price per unit in EUR. This is the canonical stored value.
          type: string
        price_usd:
          description: Price per unit converted to USD using current exchange rates.
          type: string
        views:
          description: Total number of times this currency offer has been viewed
          type: integer
        is_best_offer:
          description: >-
            Whether this offer matches the lowest price among competing listed
            offers within the same game and grouping (server, region, faction,
            etc.). Tied lowest-price offers are all marked best. Returns `false`
            when the offer is not listed or out of stock.
          type: boolean
        icon_url:
          description: URL to the currency icon image
          type: string
          nullable: true
        created_at:
          description: Unix timestamp when the currency offer was created
          type: integer
        updated_at:
          description: Unix timestamp of the last modification to the currency offer
          type: integer
        listed_at:
          description: Unix timestamp when the currency offer was made publicly available
          type: integer
          nullable: true
    GameRelation:
      description: Basic game information used in relations
      type: object
      properties:
        id:
          description: Unique identifier for the game
          type: integer
        name:
          description: Display name of the game
          type: string
        slug:
          description: URL-friendly identifier for the game
          type: string
    CurrencyUnit:
      description: Currency unit object representing a denomination of in-game currency
      type: object
      properties:
        slug:
          description: URL-friendly identifier for the currency unit
          type: string
        currency_name:
          description: Full name of the in-game currency (e.g., "Gold", "Credits")
          type: string
        name:
          description: Display name of this unit denomination
          type: string
        symbol:
          description: Symbol or abbreviation for the unit (e.g., "K", "M", "B")
          type: string
        multiplier:
          description: >-
            Numeric multiplier for unit conversion (e.g., 1000 for thousands,
            1000000 for millions)
          type: integer
    DeliveryTime:
      description: Delivery time object representing expected delivery duration
      type: object
      properties:
        duration:
          description: Numeric value representing the delivery time
          type: integer
        unit:
          description: Time unit for the duration (minutes, hours, days)
          enum:
            - minutes
            - hours
            - days
          type: string
        format:
          description: Human-readable delivery time (e.g., "2 hr")
          type: string
        format_long:
          description: Extended format delivery time (e.g., "2 hours")
          type: string
        seconds:
          description: Total delivery time converted to seconds
          type: integer
  responses:
    ErrorUnauthenticated:
      description: >-
        User is not authenticated, happens when the API key is missing, expired
        or invalid
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Unauthenticated.
    ErrorForbidden:
      description: >-
        User is not authorized to perform this action, happens when you try to
        access a resource you do not have permission to access
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: This action is unauthorized.
    ErrorNotFound:
      description: Resource not found, happens when the requested resource does not exist
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Resource not found.
    ErrorValidation:
      description: Validation errors, happens when the request data is invalid
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: The given data was invalid.
              errors:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
                example:
                  field:
                    - Something is wrong with this field!
    ErrorRateLimited:
      description: >-
        Rate limit exceeded, happens when you exceed the rate limit for the
        endpoint
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Too many requests.
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````