Loyalty API

Type

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.

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.

  • day string required

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

  • image_choice string required

    The image choice key stored with the date.

Previous
Source2