Fields are used to insert dynamic data (based on each appointment) into each message that is sent. The intention is to allow you to set up Auto Message templates that can be applied to each appointment without the user having to customize each message for each appointment.
Fields can be inserted by clicking the “Insert Field” button when editing Auto Messages. You can also type fields directly into the message using the {{ FIELDNAME }} syntax.
Fields can be used in
Fields that are available include:
Event Fields
| Field | Description |
|---|---|
| The start of the appointment unformatted. (use the “date” filter to format it) (e.g. 2013-11-15 10:00:00 -0800). |
| Nicely formatted time based on locale. e.g. “8:00am” |
| The hour (integer) that the event begins. e.g. “15” for 3pm. Mainly used in conditions. |
| The hour and minute as a number (integer). e.g. “1530” for 3:30pm. Mainly used in conditions. |
| The time zone of the event. e.g. “PDT” |
| The expanded version of the time zone. e.g. “Pacific Daylight Time” (useful in voice scripts) |
| Nicely date based on locale. e.g. “6-21” |
| Expanded date. e.g. “Tuesday, March 8thst” |
| Abbreviated date. e.g. “Tue, Mar 8th” |
| Expanded date with time. e.g. “Tuesday, March 8th at 2:00 pm” |
| Abbreviated date with time. e.g. “Tue, Mar 8th at 2:00pm” |
| Date with year. e.g. “2014-06-21” |
| Same as event.time |
| If appointment is rescheduled, then this will be the previous start time. |
| Same as event.time_phrase |
| The end of the appointment unformatted. (e.g. 2013-11-15 11:00:00 -0800). |
| Nicely formatted end time based on locale. e.g. “8:00am” |
| Phrase useful in reminders. Results in “tomorrow at 8:00am” if the event is tomorrow or “on Saturday, November 23rd at 2:00pm” if the date is after tomorrow. |
| same as day_and_time_phrase but without the time. |
| Phrase useful in reminders. Results in “tomorrow between 2 and 3 PM” if the event is tomorrow or “on Saturday, November 23rd between 2 and 3pm” if the date is after tomorrow. |
| Same as
however the day is forced to be absolute (e.g. “Wednesday” instead of “tomorrow”) |
| Same as
however the day is forced to be absolute (e.g. “Wednesday” instead of “tomorrow”) |
| Returns true if the appointment is an all day appointment. |
| The length of the appointment in minutes. To say the number of hours use:
|
| The number of days between when the appointment was created on the calendar and when the appointment takes place. This is calculated on a strict 24 hours basis… meaning if the appointment is for 4pm tomorrow and is booked at 2pm the previous day, then days_in_advance will be 2 since it’s more than 24 hours. If that is an issue, consider using hours_in_advance below. |
| The number of hours between when the appointment was created on the calendar and when the appointment takes place. |
| The number of days until the appointment. |
| The number of days since the appointment. |
| The title of the appointment in your calendar entry. |
| The contents of the “where” field in your calendar entry. |
| Same as event.where . |
| The contents of the “content” field in your calendar entry. |
| The title, where, and content, in one string with a “|” character in between each. Useful in if blocks… e.g
. |
| Same as
|
| The data found in your appointment. Apptoto looks for “key:value” in your appointments and then makes those items available for you through this field. e.g. if your appointment has service: haircut on the body of the appointment, then you can access it in your message templates with event.custom.service . e.g. would inline “haircut” into your template. See Custom Fields for more information |
| The color of the appointment on your calendars (Only supported with Google Calendar currently) |
| The categories (comma delimited) of the appointment on your calendar (Only support by Outlook and/or Exchange currently) |
| The “Show As” label of the appointment. e.g. “Busy” |
| True if the appointment is a repeating appointment |
| The date and time that the appointment was created on the calendar |
| The number of participants for the appointment |
| True if any participant of the event has said they are coming |
| True if any participant of the event has said they are not coming |
| Same as
|
| True if any participant of the event has responded |
| A string containing all of the responses from all participants separated by “|” characters. |
| True only if event was rescheduled |
| returns the line from the event (title if it’s in the title, or the particular line if it’s in the body) containing the participant’s email address. Useful if you want to customize the message for each participant depending on information on that line. |
| same as
but for the participant’s phone number |
| same as
but for both email or phone number. The line containing the email address takes precedence. |
| True if the event is the first event of the day on it’s calendar. Useful if you want to send a different message for the first appointment. Often times this is used to send a specific time for the first appointment of the day and then send a time range for all subsequent appointments. |
Virtual Meeting Fields
Virtual Meeting Fields work for both
- Appointments created through Apptoto/Zoom Integration
- Appointments created on your calendar manually with conference information in the body. Apptoto will attempt to extract virtual meeting information from the body of the event. This works for Zoom, GotoMeeting, Webex, and Jitsi. If you need Apptoto to recognize conference information from other conference solutions, please email support@apptoto.com
| Field | Description |
| (BOOLEAN) True if the meeting was created through Apptoto/Zoom integration OR if Apptoto detects that the appointment is a virtual meeting. False otherwise. |
| The link your client (or you) should click on to join the virtual meeting at meeting time. |
| The join link as a button (For email messages and appointment pages only). |
| The “Meeting Id”, “Meeting Number” or “Access Code” for the virtual meeting. |
| The “Passcode”, “Password”, or “Access Code” for the virtual meeting. |
| All of the “Call In Numbers” separated by commas. |
| The first “Call In Number” found |
| The full invite text (for Zoom Meetings created through Apptoto only). |
Calendar Fields
| Field | Description |
| The name of the calendar. By default this will be the name of the calendar at the source, but you can change the name of the calendar on the calendar settings page. |
| The name of the calendar owner. This is the same as
below. |
| All of the event titles on the same day as the appointment separated by “|” characters. This is useful if you want to set up a condition that blocks messages from going out for an appointment that is on the same day as another appointment. |
Owner Fields
| Field | Description |
|---|---|
| The name of the calendar owner. This is the same as
above. |
| The name and company of the calendar owner. |
| The name and company of the calendar owner in link form (for use in emails and appointment pages) |
| Calendar owner’s phone number. |
| Calendar owner’s phone number in link form (for use in emails and appointment pages) |
| Calendar owner’s email address. |
Location Fields
| Field | Description |
|---|---|
| The name of the location (on the “Locations” tab) |
| The phone number for the location. |
| The phone number for the location in link form (for use in emails and appointment pages) |
| The address of the location. |
| The address of the location formatted with
. (for use in emails and appointment pages) |
| The address of the location linked to Google maps |
| The description of the location. This is often used to add directions to your location. |
User Fields
These fields use the values provided on the “Settings” > “Account” tab inside of your Apptoto dashboard.
| Field | Description |
|---|---|
| The name of the user. |
| Your company name for the user. |
| The name and company of the user. |
| Your company name in link form. (for use in emails and appointment pages) |
| Your company url. |
| Your phone number. |
| Your phone number in link form. (for use in emails and appointment pages) |
| Your email address. |
| Your outgoing email address. This might be different than your email address for your account if you’ve configured it. |
Participant Fields
These fields pull in information from the participant or contact.
| Field | Description |
|---|---|
| The name of the participant. (e.g. “Fred Smith”). |
| The first name of the participant (e.g. “Fred”). |
| The last name of the participant (e.g. “Smith”). |
| The email address of the participant. (e.g. foo@gmail.com) |
| The phone number of the participant. (e.g. (650) 555-1212) |
| The normalized phone number of the participant. (e.g. +16505551212) |
| Which participant this is for the appointment. The first participant returns 1. |
| The current reminder state for the participant. Values include “initial”, “reminded”, “confirmed”, “not_coming”, “not_coming_no_reschedule”, “not_coming_needs_reschedule” |
| True if any reminder has been sent |
| The current booking state for the participant. Values include “initial”, “sent”, “accepted”, “declined” |
| True if any booking (i.e. invitation) has been sent |
| The current check in state for the participant. Values include “initial”, “arrived”, “ontime”, “late”, “noshow” |
| Returns true if the current check in state for the participant is “arrived”, “ontime”, or “late”. |
| This field rolls up the booking_state, reminder_state, and check_in_state into one. i.e. when the check_in_state is set, then this field is the check_in_state. If the check_in_state is not sent, then the reminder_state is used. If the reminder_state is not set, then the booking_state is used, and if none of them are set then the value of this field is “initial” |
| The current booking state for the attendee on the source calendar. This is really only useful for calendars types (like Google) which have the ability to send invites themselves. If the client responds accepts/declines, etc through those invites, then you can access that information through the
field. The values for this field are “initial”, “sent”, “accepted”, “declined”, and “tentative” |
| A string containing all of the responses from this participant separated by “|” characters. |
| Appointments can be grouped together using our BETA Appointment Grouping Feature. e.g. all appointments with the same person on the same day can all be considered a group. Only one set of messages can be sent for all of them. The messages can list out all of the appointments on that same day using this field. |
| The number of appointments in this group |
| Very similar to
but data is pulled from the associated contact (if one exists). See Custom Fields for more information |
| The locale for the participant based on which “Message Schedule” was used for the participant. The possible values are en-US, en-AU, en-GB, nl, fr, es, and de. |
Contact Fields
These fields pull in information from the contact in the address book, if the event is linked to a contact via Apptoto auto-matching or explicitly.
| Field | Description |
|---|---|
| The name of the participant. (e.g. “Fred Smith”). |
| The first name of the participant (e.g. “Fred”). |
| The last name of the participant (e.g. “Smith”). |
| The email address of the participant. (e.g. foo@gmail.com) |
| The phone number of the participant. (e.g. (650) 555-1212) |
| The normalized phone number of the participant. (e.g. +16505551212) |
| The zip code of the contact (e.g. 97701) |
| The external id of the contact in the address book |
| Very similar to
but data is pulled from the associated contact in the address book. See Custom Fields for more information |
Message Fields
“Message fields” are fields that are specific to the type of message that is being sent. For example, reminders have the following fields.
| Field | Description |
|---|---|
| The date and time that the reminder is being generated. This is not the appointment time. |
| The url to the “Appointment Page” for the reminder. The user will be able to find out more information about the appointment and confirm/cancel from the Appointment Page. |
| The prompt string automatically generated depending on the type of reminder. e.g. if the reminder type is an SMS message, then the prompt will say “Please reply with 1 to confirm.” if you have it set up to only allow confirmations. |
| Only useful in email messages. Same thing as “prompt” above except the options are buttons that the end-user can click on. |
“Booking” and “Followup” messages have the same fields as above, e.g. “booking.link” or “followup.link” .
Reply Fields
These fields are useful in auto-reply actions.
| Field | Description |
|---|---|
| The type of trigger that caused the auto reply action to take place. |
| The reply from the participant |
| Same as
|
| The date and time of when the participant replied |
Booking Page Fields
These fields are available only when the appointment was booked through an Apptoto Online Booking page.
| Field | Description |
|---|---|
| The booking fields as a long string… one field each |
| The value entered by the client when booking an appointment and filling out one of the custom fields for your booking page |
| The ip address of the client used when booking the appointment |
| The appointment type’s label selected |
| The appointment type’s description |
| The shortened “token” of the appointment type. Typically very similar to the label, but with no spaces |
| A direct link back to the booking page that immediately asks the client to pick a new time |
| The name of the booking page |
| The title of the booking page |
| The url of the booking page used |