Follow Up Boss icon

Follow Up Boss

Interact with the Follow Up Boss API

Actions148

Appointment → Create

AI-generated

Summary

Create an appointment in Follow Up Boss.

Inputs

  • authentication — Authentication method for the Follow Up Boss API. Defaults to API Key if not specified. Options: API Key, OAuth2.
  • start (required) — Start time of the appointment. Type: dateTime.
  • end (required) — End time of the appointment. Type: dateTime.
  • title (required) — Title of the appointment. Type: string. Placeholder: e.g. Initial Consultation.
  • typeId — The type of the appointment. Choose from the list or specify a valid numeric ID. Modes: By ID (string matching [0-9]+), From list (populated via getAppointmentTypes).
  • additionalFields — Collection of additional appointment details. Default: {}. Options: allDay (boolean, default false), description (string), inviteeEmails (comma-separated string), inviteePersonIds (comma-separated string), inviteeRelationshipIds (comma-separated string), inviteeUserIds (comma-separated string), outcomeId (resourceLocator with similar ID/list modes).

Output shape

The created appointment record as returned by the Follow Up Boss API.

Includes all set parameters plus any system-generated fields. Exact shape depends on API response.

Examples

Example 1: Create a 1-hour initial consultation appointment.

Authentication: API Key (default); Start: 2024-05-15T09:00:00Z; End: 2024-05-15T10:00:00Z; Title: Initial Consultation; Type: leave blank or select from list; Additional Fields: allDay false, outcomeId leave blank.

Links

Discussion