v1

latestOpenAPI 3.0.12026-07-13139143370.4 KB
Locations

Update Reminders

Use this endpoint to Update Email and SMS appointment reminder settings for the requested location. A valid business location id is required.

Appointment Reminders Reminder values are used to define how many hours, days, or weeks (interval value) prior to the appointment to send the reminder. Interval values are used to define the reminder interval: 1 = Hours, 2 = Days and 3 = Weeks. The reminder fields are numbers. If you are using the hours interval, use a number from 1 to 24.

Example 1: emailFirstReminder: 1, emailFirstReminderInterval: 2 - results in 1st reminder being sent 1 Day before the appointment time.

Example 2: emailSecondReminder: 3, emailSecondReminderInterval: 1 - results in 2nd reminder being sent 3 Hours before the appointment time.

put/setup/v1/locations/{id}/appointmentreminders

Path parameters

idstring required

id of business location, defaults to primary business location

Request body

emailFirstReminderinteger nullable
emailFirstReminderIntervalinteger
emailSecondReminderinteger nullable
emailSecondReminderIntervalinteger
smsFirstReminderinteger nullable
smsFirstReminderIntervalinteger
smsSecondReminderinteger nullable
smsSecondReminderIntervalinteger

Response

Success

objectstring nullable
idstring nullable
friendlyIdstring nullable
companyIdstring nullable
companyNamestring nullable
namestring nullable
adminEmailstring nullable
adminNamestring nullable
phonestring nullable
faxstring nullable
emailstring nullable
websitestring nullable
regionIdstring nullable
logostring nullable
imageUrlstring nullable
timezoneIdstring nullable
timezoneIanastring nullable
timezoneOffsetinteger nullable
primaryBusinessboolean
primaryCalendarIdstring nullable
latitudenumber double
longitudenumber double