accounts | array (also accepts a comma-separated string) | Yes | - | Select the Business Profile locations to update, ask the user for it if not provided. The same hours are applied to every selected location. |
hours_type | string or SelectableOption | Yes | - | Which hours to set. Available options: ‘regular’ (the weekly opening hours) or ‘special’ (holiday and one off hours that override the weekly hours). |
regular_hours | array (also accepts a comma-separated string) | No | - | Used when hours_type is ‘regular’. One row per opening period with fields: ‘day’ (Monday to Sunday), ‘open’ and ‘close’ as 24 hour ‘HH:MM’ times. Optional ‘close_day’ for periods running past midnight, and ‘closed’ set to true to mark a day closed. IMPORTANT: this replaces the whole week, so include every open day; any day without a row becomes closed. Add two rows for the same day to create a split shift such as a lunch break. |
special_hours | array (also accepts a comma-separated string) | No | - | Used when hours_type is ‘special’. One row per date with fields: ‘date’ (YYYY-MM-DD), optional ‘end_date’ for a range, and either ‘closed’ set to true or ‘open’ and ‘close’ as 24 hour ‘HH:MM’ times. IMPORTANT: this replaces all existing special hours, so include every date you want to keep. |