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

# Update an event auction item

> Configures bidding prices, stock, visibility and auction status. Omitted fields are preserved when updating. Requires the event management capability; all referenced records must belong to this event and organization.



## OpenAPI

````yaml put /admin/events/{eventId}/auction-items/{id}
openapi: 3.0.0
info:
  title: Gratona API
  description: >-
    REST API for the Gratona fundraising platform, including donor, donation,
    sponsorship, program, event, and integration workflows. Endpoints are
    organized by tag. Most endpoints require either a Passport bearer token or
    an issued API key — see the Security Schemes section.
  contact:
    name: Gratona Engineering
    url: https://gratona.com
    email: devs@gratona.com
  version: 1.0.0
servers:
  - url: https://api.gratona.com/v1
    description: Server Version 1.0.0
security: []
tags:
  - name: Auth
    description: >-
      Login, signup, logout, password reset, and email verification for admin
      users and donors.
  - name: Donors
    description: >-
      Donor records: CRUD, profile fields, household linkage, search, filters,
      merge, and duplicate detection.
  - name: Donations
    description: >-
      Individual donation records, recurring commitments, soft credits, refunds,
      designations, and exports.
  - name: Sponsorships
    description: >-
      Donor-to-entity commitment relationships, lifecycle transitions, and
      commitment-specific filters.
  - name: Entities
    description: >-
      Recipient records (children, families, projects, animals, etc.), their
      status, and entity-level fields.
  - name: Programs
    description: >-
      Program / campaign configuration: hierarchy, settings, and program-level
      metadata.
  - name: Forms
    description: >-
      Custom form builder (HysForm), form fields, standardized donor fields, and
      field migrations.
  - name: Trips
    description: >-
      Mission-trip management: trips, participants, budgets, tasks,
      e-signatures, fundraising milestones, and background checks.
  - name: Communications
    description: >-
      Email templates, SMS, newsletters, donor email manager, and per-donor
      notes.
  - name: Payments
    description: >-
      Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks).
      Excludes inbound webhooks — see the Webhooks tag.
  - name: Reports
    description: Dashboards, analytics, scheduled reports, and exports.
  - name: Admin
    description: >-
      Client-account administration: users, groups/permissions, settings,
      integrations, and account lifecycle.
  - name: Donor Portal
    description: >-
      Endpoints consumed by the donor-facing portal (donor login, dashboard,
      donation history, messages).
  - name: Recipient Portal
    description: Endpoints consumed by the recipient-facing portal.
  - name: Public
    description: >-
      Unauthenticated public endpoints: donor signup, public trip pages,
      peer-to-peer campaigns, public checkout.
  - name: Webhooks
    description: >-
      Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr,
      DropboxSign). Annotated minimally for reference; payload shapes are owned
      by the upstream provider.
  - name: Events
    description: >-
      Event setup, invitations, registration, ticketing, attendance and event
      reporting.
  - name: Journeys
    description: >-
      Journey graphs, activation, enrollment, message templates and event
      follow-up automations.
  - name: Tasks
    description: Workspace tasks, assignments, saved task views and record collaboration.
  - name: Fundraising
    description: >-
      Fundraising portfolios, stewardship plans, giving anniversaries and
      personal donor follow-up.
  - name: Impact Stories
    description: Story intake, review, assets, consent and publication workflows.
  - name: Integrations
    description: Workspace integration connections, mappings, synchronization and recovery.
  - name: Email Calendar
    description: Connected email/calendar accounts and donor interactions.
  - name: Spaces
    description: Workspace Spaces and collaborative Pages.
  - name: Library
    description: Workspace documents, source connections, files and analysis.
  - name: Intelligence
    description: Donor intelligence and Tali workspace workflows.
  - name: Automation
    description: >-
      V3 automation primitive discovery, input validation, invocation and Zapier
      contracts.
  - name: Schema
    description: V3 model, enum, capability and scope discovery.
  - name: Zapier
    description: Zapier automation connections, polling feeds and actions.
  - name: Files
    description: Files
  - name: Client
    description: Client
  - name: Payment Gateways
    description: Payment Gateways
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Recipients
    description: Recipients
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Settings
    description: Settings
  - name: Notifications
    description: Notifications
  - name: Participation
    description: Participation
  - name: Users
    description: Users
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
  - name: Workspace
    description: Workspace
paths:
  /admin/events/{eventId}/auction-items/{id}:
    put:
      tags:
        - Events
      summary: Update an event auction item
      description: >-
        Configures bidding prices, stock, visibility and auction status. Omitted
        fields are preserved when updating. Requires the event management
        capability; all referenced records must belong to this event and
        organization.
      operationId: EventController_updateAuctionItem
      parameters:
        - name: eventId
          in: path
          description: Record ID in the authenticated organization.
          required: true
          schema:
            type: integer
            example: 42
          example: 42
        - name: id
          in: path
          description: Journey ID in the authenticated organization.
          required: true
          schema:
            type: integer
            example: 42
          example: 42
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                name:
                  description: Name.
                  type: string
                  maxLength: 255
                  example: Annual Gala
                description:
                  description: Description.
                  type: string
                  example: Example
                  nullable: true
                fair_market_value:
                  description: Fair market value.
                  type: number
                  minimum: 0
                  example: 1
                  nullable: true
                starting_bid:
                  description: Starting bid.
                  type: number
                  minimum: 0
                  example: 1
                  nullable: true
                buy_now_price:
                  description: Buy now price.
                  type: number
                  minimum: 0
                  example: 1
                  nullable: true
                quantity_available:
                  description: Quantity available.
                  type: integer
                  minimum: 0
                  example: 1
                  nullable: true
                status:
                  description: Status.
                  type: string
                  enum:
                    - draft
                    - open
                    - closed
                    - fulfilled
                    - cancelled
                    - null
                  example: draft
                  nullable: true
                visibility:
                  description: Visibility.
                  type: string
                  enum:
                    - public
                    - private
                    - null
                  example: public
                  nullable: true
                sort_order:
                  description: Sort order.
                  type: integer
                  example: 1
                  nullable: true
                settings:
                  description: Settings.
                  type: object
                  nullable: true
                  additionalProperties: true
              type: object
      responses:
        '200':
          description: Update an event auction item completed.
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/EventApiAuctionItem'
                type: object
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Insufficient permission or feature access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found in the organization or feature unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '422':
          description: Invalid setup fields, chronology or organization/event references.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestRejection'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    EventApiAuctionItem:
      properties:
        id:
          description: Id.
          type: integer
          example: 1
        client_id:
          description: Client id.
          type: integer
          example: 1
          nullable: false
        event_id:
          description: Event id.
          type: integer
          example: 1
          nullable: false
        name:
          description: Name.
          type: string
          example: Annual Gala
          nullable: false
        description:
          description: Description.
          type: string
          example: Example
          nullable: true
        fair_market_value:
          description: Fair market value serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        starting_bid:
          description: Starting bid serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        buy_now_price:
          description: Buy now price serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: true
        quantity_available:
          description: Quantity available.
          type: integer
          example: 1
          nullable: true
        quantity_sold:
          description: Quantity sold.
          type: integer
          example: 1
          nullable: false
        status:
          description: Status.
          type: string
          enum:
            - draft
            - open
            - closed
            - fulfilled
            - cancelled
          example: draft
          nullable: false
        visibility:
          description: Visibility.
          type: string
          enum:
            - public
            - private
          example: public
          nullable: false
        sort_order:
          description: Sort order.
          type: integer
          example: 1
          nullable: false
        settings:
          description: Settings.
          type: object
          nullable: true
          additionalProperties: true
        created_at:
          description: Created at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Updated at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        deleted_at:
          description: Deleted at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        bid_summary:
          properties:
            active_bid_count:
              description: active bid count.
              type: integer
              example: 42
            awarded_count:
              description: awarded count.
              type: integer
              example: 42
            bid_count:
              description: bid count.
              type: integer
              example: 42
            purchased_count:
              description: purchased count.
              type: integer
              example: 42
            high_bid:
              description: high bid.
              type: number
              example: 0
            settled_total:
              description: settled total.
              type: number
              example: 0
            last_bid_at:
              description: last bid at.
              type: string
              example: Example
              nullable: true
            leader_at:
              description: leader at.
              type: string
              example: Example
              nullable: true
            leader_signature:
              description: leader signature.
              type: string
              example: Example
              nullable: true
            leader_status:
              description: leader status.
              type: string
              example: Example
              nullable: true
            winner:
              description: winner.
              type: string
              example: Example
              nullable: true
          type: object
      type: object
    ErrorResponse:
      title: ErrorResponse
      description: >-
        Generic error envelope used by most controllers. Most error responses
        pair a human-readable `message` with `status: error`. Some endpoints
        additionally include `errors` (validator errors), `error` (legacy
        single-error string), `code`, or domain-specific context fields.
      required:
        - message
      properties:
        message:
          description: Human-readable error message.
          type: string
          example: Something went wrong. Please try again.
        status:
          description: >-
            Always the literal string `error` for failures. Some endpoints omit
            this field.
          type: string
          example: error
        error:
          description: Legacy single error code/string used by older endpoints.
          type: string
          example: invalid_request
          nullable: true
        code:
          description: >-
            Optional application-level error code (not all endpoints populate
            this).
          type: string
          example: DONOR_NOT_FOUND
          nullable: true
      type: object
    NotFoundResponse:
      title: NotFoundResponse
      description: >-
        Returned with HTTP 404 when a resource lookup misses (typically because
        the id doesn't exist OR is scoped to a different `client_id`). Note:
        many endpoints intentionally collapse 'not found' and 'forbidden' into a
        single 404 to avoid leaking which records exist in another tenant.
      required:
        - message
      properties:
        message:
          description: >-
            Human-readable message. Often a more specific string like `Donor not
            found` or `Trip not found`.
          type: string
          example: Not Found
        status:
          type: string
          example: error
      type: object
    RequestRejection:
      description: >-
        Request or workflow rejection. Framework field-validation failures
        contain errors; semantic rejections may contain message without errors;
        legacy/provider failures may use error and error_code. The operation
        description identifies the rejected condition. Domain responses may add
        current revision, limits or other conflict context.
      anyOf:
        - $ref: '#/components/schemas/ValidationErrorResponse'
        - $ref: '#/components/schemas/ErrorResponse'
        - required:
            - error
          properties:
            error:
              description: Legacy or provider-facing error message.
              type: string
              example: The request could not be completed.
            error_code:
              description: Stable domain error code, when provided.
              type: string
              example: WORKFLOW_UNAVAILABLE
          type: object
    ValidationErrorResponse:
      title: ValidationErrorResponse
      description: >-
        Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The
        `errors` map is keyed by the failing field name; each value is an array
        of human-readable error messages for that field. Most controllers also
        include a top-level `status: error`.
      required:
        - errors
      properties:
        errors:
          description: >-
            Map of field name to array of validator error messages. Example:
            `{email: [The email field is required.], amount: [The amount must be
            a number.]}`.
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        status:
          description: Always the literal string `error`.
          type: string
          example: error
        message:
          description: >-
            Optional summary message — present on some endpoints, absent on
            others.
          type: string
          example: The given data was invalid.
          nullable: true
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      description: Passport bearer token authentication for legacy admin sessions.
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      description: Gratona API key sent with the compatibility header X-HYS-API-Key.
      name: X-HYS-API-Key
      in: header

````

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