/appointments

post https://api.followupboss.com/v1/appointments

Create an appointment.

time	status	user agent
Retrieving recent requests…

Loading…

📘
Invitees
The invitees argument can contain both /people or /users objects.

📘
Appointment Types Outcomes
Appointment Types determine what kind of appointment is being created. See /appointmentTypes for a list of options.
Appointment Outcomes are used to describe what the result is for a particular appointment. See /appointmentOutcomes for a list of options.

🚧
Syncing with Third-Party Calendars
Appointments created in Follow Up Boss will sync with Third-Party Calendars (Gmail, Outlook), but only if the invitees list contains the Follow Up Boss user with a properly synced calendar as well as any other invitees.

Query Params

sendInvitation

boolean

Defaults to false

Send an invitation email to invitees. (Note: If the "appointment reminders" is enabled, an SMS reminder will also be sent.)

Body Params

title

string

required

Title of the appointment.

description

string

Description of the appointment or event.

invitees

json

Array of users and/or people to invite to the appointment. (e.g., User object: {userId: 1, name: "Tom Minch"}, People object: {personId: "123", name: "John Q Customer", email: "johnq@example.com"})

allDay

boolean

Defaults to false

Sets whether the appointment is an all day event or not.

start

string

required

The beginning date and time of the appointment (in UTC, also supports time zone suffix).

end

string

required

The ending date and time of the appointment (in UTC, also supports time zone suffix).

location

string

The location or address of the appointment.

createdById

int32

The id of the user that created the appointment. (Note: This can only be set by admins, otherwise the currently logged in user's ID is used.)

typeId

int32

The Follow Up Boss appointment type identifier.

outcomeId

int32

The Follow Up Boss appointment outcome identifier.

Responses

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://api.followupboss.com/v1/appointments?sendInvitation=false' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"allDay":false}'


xxxxxxxxxx
37
}
1
{
2
  "id": 13854,
3
  "created": "2020-09-04T15:13:18Z",
4
  "updated": "2020-09-04T15:13:18Z",
5
  "createdById": 1,
6
  "updatedById": 1,
7
  "title": "Lunch",
8
  "description": "Tom and John Q. are having lunch. Gotta try the new \"impossible\" burger",
9
  "start": "2020-09-04T16:00:00Z",
10
  "end": "2020-09-04T17:00:00Z",
11
  "allDay": false,
12
  "originFub": true,
13
  "location": "",
14
  "invitees": [
15
    {
16
      "userId": 1,
17
      "personId": null,
18
      "name": "Tom Minch",
19
      "email": "tom@example.com",
20
      "picture": "https://placekitten.com/408/287"
21
    },
22
    {
23
      "userId": null,
24
      "personId": 44673,
25
      "name": "John Q Customer",

/appointments

📘
Invitees

📘
Appointment Types Outcomes

🚧
Syncing with Third-Party Calendars

📘Invitees

📘Appointment Types Outcomes

🚧Syncing with Third-Party Calendars

200200

400400

📘
Invitees

📘
Appointment Types Outcomes

🚧
Syncing with Third-Party Calendars