SpecialDate1

A customer’s named annual occasion.

Kind	Type
Used in	Cart2, CustomerBalance3, CustomerDetails1, EstimateAccrual1, ListDocuments3, ListOrders3, ListReferrals3, LoadCart1, LoggedOutBalance1, UpdateCustomerDetails1, UpdateCustomers3, UpdateOrders4, UpdateSubscriptions1

Dates are returned in month/day order.

Updating a date replaces person_name and note entirely. Resending an existing date without these fields clears them.

Two dates that differ only in person_name are distinct dates. Two dates identical in name, day, person_name and image_choice are duplicates and cannot coexist.

Properties

• bhid bubbleflake optional

  Bubblehouse ID. Include when editing an existing date; omit for a new date.

• name string required

  The occasion name, between 1 and 100 characters.

• person_name string optional

  The name of the person this date belongs to, up to 100 characters. Optional.

• note string optional

  A free-form note about the occasion, up to 100 characters. Optional. Merchants can use it for details such as a favorite product.

• day string required

  The month and day of the occasion as a yearless date in 0000-MM-DD format.

• image_choice string optional

  The exact positive decimal image choice key, without leading zeros. Optional: omit it or send an empty string when no image is wanted, for example when the shop configures no images. When used, take key from DataListOptions1 with dataset=special_date_images. Send only this key, not image metadata or a URL.