Create an appointment

Books an appointment. Send it inside a calendar_event object. title, start_time and end_time
are required, and end_time must be after start_time. Set appointment_type to inspection for
a roof inspection or adjuster for a meeting with the insurance adjuster; it defaults to regular.

For an adjuster appointment linked to a lead or job, you can also send an adjuster object with
adjuster_name, adjuster_phone and adjuster_email. Changed values are saved to the deal's
primary insurance claim, which is created if the deal has none, and need a role that can edit the
claim.

To link the appointment to a deal, send eventable_type (Contact, Lead or Job) and
eventable_id. The appointment belongs to the token's user unless you send user_id, which
requires a role that can book for others. The user can't already have an overlapping appointment
(allowing for your company's buffer between appointments).

When the appointment is saved:

  • If it's linked to a lead, an "appointment scheduled" entry is added to the lead's timeline.
  • If the homeowner has an email address and has opted in to email, they are sent a calendar
    invite.
  • If the user has connected Google Calendar or Outlook, the appointment is copied there.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
calendar_event
object
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json