Appointments

Appointments The Appointments API lets you book appointments for your contacts on your event types, then fetch, list, update, cancel, or delete them. When a Google Calendar connection is active, the matching calendar event is created and kept in sync automatically in the background. All paths on this page are relative to the base URL https://api.relaytiv.com/v1 . Every request needs your API key — see Authentication for the full list of ways to send it. The examples below use the X-API-Key header, with one cURL example showing the ?apiKey= query form too. Events vs. appointments: An event type is a bookable slot definition (the kind of meeting, its length, its rooms). An appointment is one booked instance of an event type for a specific contact. You book an appointment by referencing the contact and the event type. The appointment object Every endpoint that returns an appointment uses the same shape: Field Description id Unique ID of the appointment. contact_id ID of the contact the appointment is booked with. event_id ID of the event type the appointment was booked on. status Confirmed or Canceled . start_time Start of the appointment, ISO 8601 in UTC. end_time End of the appointment, ISO 8601 in UTC. created_at When the appointment was created. last_modified_at When the appointment was last changed. room_name Room or resource the appointment is booked in, when the event type uses rooms. description Free-form description of the appointment. summary Short summary or title. ca