Update Sale

Update an existing auction/sale event. Only include the fields you want to change.

PATCH /datatable-sales/{id}

Writable Fields

All fields that can be set during sale creation (POST) can also be updated via PATCH. Only include the fields you want to modify.

Example Request - Update Basic Information

PATCH /api/v1.0/datatable-sales/888

{
  "subtitle": "Updated: Spring Rare Stamps Auction 2025",
  "published": 1
}

Example Request - Update Dates

{
  "mail_sale_date_from": 1711929600000,
  "mail_sale_date_to": 1712707200000,
  "live_sale_date_from": 1712707200000,
  "live_sale_date_to": 1712793600000
}

Note: Dates are in milliseconds (JavaScript timestamps)

Example Request - Update Financial Settings

{
  "buyers_premium": "22% up to $10,000, 18% thereafter",
  "post_sale_discount": 7.5
}

Example Request - Lock Lots

{
  "lots_locked": 1
}

Example Request - Update Configuration

{
  "sync_active": 1,
  "display_live_links": 1,
  "hide_sold_information": 0,
  "hide_sale": 0
}

Example Request - Update Media Links

{
  "pdf_link": "https://example.com/updated-catalog.pdf",
  "pdf_sale_result": "https://example.com/results.pdf",
  "e_book_link": "https://example.com/ebook-catalog"
}

Example Request - Update Departments

{
  "departments": ["Stamps", "Postal History", "Covers"]
}

Note: Arrays completely replace existing values

Example Request - Update Additional Charges

{
  "additional_charges": [
    {
      "amount": 60.00,
      "term": 10,
      "description": "Updated catalog subscription",
      "attached_to": "sale",
      "tax": 12.00
    },
    {
      "amount": 35.00,
      "term": 15,
      "description": "Digital access fee",
      "attached_to": "sale",
      "tax": 7.00
    }
  ]
}

Example Request - Update Display Information

{
  "date_and_location_string": "May 10-11, 2025 | Grand Auction Hall, London",
  "next_consignment_notice": "Now accepting consignments for Summer 2025",
  "auctioneer_name": "Updated Auctioneer Name"
}

Response

{
  "data": [{
    "id": "888",
    "uuid": "xyz-abc-888",
    "subtitle": "Updated: Spring Rare Stamps Auction 2025",
    "published": true,
    "status": {
      "value": "upcoming",
      "label": "Upcoming"
    },
    "sale_number": "SALE-2025-001",
    "buyers_premium": "22% up to $10,000, 18% thereafter",
    "post_sale_discount": 7.5,
    "lots_locked": 1,
    "updated": "2025-12-31T15:30:00Z"
  }]
}

Updatable Field Categories

published, description, subtitle, sale_type, sale_number, auctioneer_name

mail_sale_date_from, mail_sale_date_to, live_sale_date_from, live_sale_date_to, last_date_for_consignment, auto_sync_image_end_date

buyers_premium, post_sale_discount, initial_finder_fees_orders, additional_charges (multifield), bid_steps

lots_locked, next_consignment_notice, date_and_location_string, item_images_dir, sync_active, display_live_links, hide_sold_information, hide_sale

pdf_link, pdf_sale_result, e_book_link

departments, external_ids (multifield)

Read-Only Fields (Cannot be Updated)

The following fields are read-only and will be ignored if included in PATCH requests:

id, label, uuid
status (computed)
logo (read-only file)
image_stats (computed)
sale_url, saleWebsiteLink (generated)
migrate_item_info, migrate_delcampe_info, migrate_san_info (computed)
created, updated timestamps

Important Notes

PATCH requests are partial updates - only send fields you want to change
All dates are in milliseconds (JavaScript timestamps)
Server converts milliseconds to Unix timestamps (seconds)
Date range fields split into _from and _to variants
Monetary values in cents
Taxonomy terms (departments) can be sent as IDs or labels
Multifield arrays completely replace existing values - not merged
Client access is restricted in token mode (view-only)
lots_locked prevents editing of lots in the sale
sync_active controls automatic synchronization
hide_sale hides entire sale from public view
hide_sold_information hides only sold prices/buyers
See Create Sale for detailed field descriptions and structures