# Microsoft Bookings

> Book, reschedule and cancel Microsoft Bookings appointments, keep customers up to date, and start workflows when appointments are booked, changed or cancelled.

App · 18 actions. Web page: https://docs.lodol.com/docs/integrations/microsoft-bookings

## Actions

### Add customer

Add a customer to a Bookings calendar.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.
- Name (`name`, text, required): The customer's name.
- Email (`email`, text): The customer's email address.
- Phone (`phone`, text): The customer's phone number.
- Phone type (`phone_type`, text): What kind of number it is. One of: `mobile`, `home`, `business`, `other`. Default: `mobile`.
- Street (`street`, text): The street address.
- City (`city`, text): The city.
- State (`state`, text): The state or province.
- Postal code (`postal_code`, text): The postal code.
- Country (`country`, text): The country or region.

**Outputs**

- `customer` (object): A customer

**Example output**

```json
{
  "customer": {
    "addresses": [
      {
        "city": "Buffalo",
        "countryOrRegion": "USA",
        "postalCode": "98052",
        "state": "NY",
        "street": "4567 Main Street"
      }
    ],
    "createdDateTime": "2026-10-01T15:02:11Z",
    "displayName": "Joni Sherman",
    "emailAddress": "jonis@relecloud.com",
    "id": "36038f36-634e-44e4-9415-d7d59c2347aa",
    "lastUpdatedDateTime": "2026-10-01T15:02:11Z",
    "phone": "206-555-0199",
    "phones": [
      {
        "number": "206-555-0199",
        "type": "mobile"
      }
    ]
  }
}
```

### Book appointment

Book an appointment for a customer, either one already in Bookings or a new one by name and email. Bookings emails the customer a confirmation unless you turn it off.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.
- Service (`service_id`, text, required): The service.
- Start time (`start_time`, date and time, required): When the appointment starts.
- End time (`end_time`, date and time): When it ends. Leave empty to use the service's usual length.
- Customer (`customer_id`, text): A customer already in Bookings. Leave empty to book a new one with the name and email.
- Customer name (`customer_name`, text): The new customer's name. Needed when no customer is picked.
- Customer email (`customer_email`, text): The new customer's email.
- Customer phone (`customer_phone`, text): The customer's phone number.
- Customer notes (`customer_notes`, text): Notes from a new customer, shown to staff.
- Staff (`staff_member_ids`, list): The staff to book for it. Leave empty for none.
- Staff notes (`service_notes`, text): Notes for staff about this appointment.
- Send confirmation email (`send_confirmation`, true/false): Email the customer a confirmation, as Bookings does. Default: `true`.

**Outputs**

- `appointment` (object): An appointment

**Example output**

```json
{
  "appointment": {
    "additionalInformation": "Bring photo ID for both applicants.",
    "createdDateTime": "2026-10-28T09:12:00Z",
    "customerEmailAddress": "jonis@relecloud.com",
    "customerName": "Joni Sherman",
    "customerNotes": "",
    "customerPhone": "206-555-0199",
    "customerTimeZone": "America/Chicago",
    "customers": [
      {
        "customerId": "36038f36-634e-44e4-9415-d7d59c2347aa",
        "emailAddress": "jonis@relecloud.com",
        "name": "Joni Sherman",
        "phone": "206-555-0199",
        "timeZone": "America/Chicago"
      }
    ],
    "duration_minutes": 30,
    "end_time": "2026-11-03T15:30:00Z",
    "id": "AAMkADc7zF4J0AAA8v_KnAAA=",
    "isLocationOnline": false,
    "joinWebUrl": "",
    "lastUpdatedDateTime": "2026-10-28T09:12:00Z",
    "optOutOfCustomerEmail": false,
    "price": 0,
    "priceType": "free",
    "selfServiceAppointmentId": "00000000-0000-0000-0000-000000000000",
    "serviceId": "57da6774-a087-4d69-b0e6-6fb82c339976",
    "serviceName": "Marriage licence appointment",
    "serviceNotes": "",
    "staffMemberIds": [
      "8ee1c803-a1fa-406d-8259-7ab53233f148"
    ],
    "start_time": "2026-11-03T15:00:00Z"
  }
}
```

### Cancel appointment

Cancel an appointment and email the customer your message, as cancelling in Bookings does.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.
- Appointment (`appointment_id`, text, required): The appointment. Pick one of the next 60 days', or use its id from List appointments or a trigger.
- Message to the customer (`message`, text): Sent to the customer with the cancellation. Default: `Your appointment has been cancelled.`.

**Outputs**

- `appointment_id` (text): The id of the record cancelled
- `cancelled` (true/false): Always true once cancelled

**Example output**

```json
{
  "appointment_id": "AAMkADc7zF4J0AAA8v_KnAAA=",
  "cancelled": true
}
```

### Delete appointment

Delete an appointment without sending the customer a cancellation. To tell them, use Cancel appointment instead.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.
- Appointment (`appointment_id`, text, required): The appointment. Pick one of the next 60 days', or use its id from List appointments or a trigger.

**Outputs**

- `appointment_id` (text): The id of the record deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "appointment_id": "AAMkADc7zF4J0AAA8v_KnAAA=",
  "deleted": true
}
```

### Delete customer

Delete a customer from a Bookings calendar. Their past appointments stay.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.
- Customer (`customer_id`, text, required): The customer.

**Outputs**

- `customer_id` (text): The id of the record deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "customer_id": "36038f36-634e-44e4-9415-d7d59c2347aa",
  "deleted": true
}
```

### Get appointment

Get one appointment, including the customer's and staff's notes.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.
- Appointment (`appointment_id`, text, required): The appointment. Pick one of the next 60 days', or use its id from List appointments or a trigger.

**Outputs**

- `appointment` (object): An appointment

**Example output**

```json
{
  "appointment": {
    "additionalInformation": "Bring photo ID for both applicants.",
    "createdDateTime": "2026-10-28T09:12:00Z",
    "customerEmailAddress": "jonis@relecloud.com",
    "customerName": "Joni Sherman",
    "customerNotes": "",
    "customerPhone": "206-555-0199",
    "customerTimeZone": "America/Chicago",
    "customers": [
      {
        "customerId": "36038f36-634e-44e4-9415-d7d59c2347aa",
        "emailAddress": "jonis@relecloud.com",
        "name": "Joni Sherman",
        "phone": "206-555-0199",
        "timeZone": "America/Chicago"
      }
    ],
    "duration_minutes": 30,
    "end_time": "2026-11-03T15:30:00Z",
    "id": "AAMkADc7zF4J0AAA8v_KnAAA=",
    "isLocationOnline": false,
    "joinWebUrl": "",
    "lastUpdatedDateTime": "2026-10-28T09:12:00Z",
    "optOutOfCustomerEmail": false,
    "price": 0,
    "priceType": "free",
    "selfServiceAppointmentId": "00000000-0000-0000-0000-000000000000",
    "serviceId": "57da6774-a087-4d69-b0e6-6fb82c339976",
    "serviceName": "Marriage licence appointment",
    "serviceNotes": "",
    "staffMemberIds": [
      "8ee1c803-a1fa-406d-8259-7ab53233f148"
    ],
    "start_time": "2026-11-03T15:00:00Z"
  }
}
```

### Get Bookings calendar

Get a Bookings calendar's details: contact details, address and booking page.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.

**Outputs**

- `business` (object): A Bookings calendar

**Example output**

```json
{
  "business": {
    "address": {
      "city": "Buffalo",
      "countryOrRegion": "USA",
      "postalCode": "98052",
      "state": "NY",
      "street": "4567 Main Street"
    },
    "businessType": "Government",
    "defaultCurrencyIso": "USD",
    "displayName": "City Clerk",
    "email": "cityclerk@contoso.com",
    "id": "Cityclerk@contoso.onmicrosoft.com",
    "isPublished": true,
    "languageTag": "en-US",
    "phone": "206-555-0100",
    "publicUrl": "https://outlook.office365.com/owa/calendar/Cityclerk@contoso.onmicrosoft.com/bookings/",
    "webSiteUrl": "https://www.contoso.com"
  }
}
```

### Get customer

Get one customer's details.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.
- Customer (`customer_id`, text, required): The customer.

**Outputs**

- `customer` (object): A customer

**Example output**

```json
{
  "customer": {
    "addresses": [
      {
        "city": "Buffalo",
        "countryOrRegion": "USA",
        "postalCode": "98052",
        "state": "NY",
        "street": "4567 Main Street"
      }
    ],
    "createdDateTime": "2026-10-01T15:02:11Z",
    "displayName": "Joni Sherman",
    "emailAddress": "jonis@relecloud.com",
    "id": "36038f36-634e-44e4-9415-d7d59c2347aa",
    "lastUpdatedDateTime": "2026-10-01T15:02:11Z",
    "phone": "206-555-0199",
    "phones": [
      {
        "number": "206-555-0199",
        "type": "mobile"
      }
    ]
  }
}
```

### Get service

Get one service's details.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.
- Service (`service_id`, text, required): The service.

**Outputs**

- `service` (object): A service customers can book

**Example output**

```json
{
  "service": {
    "additionalInformation": "Bring photo ID for both applicants.",
    "defaultDuration": "PT30M",
    "defaultPrice": 0,
    "defaultPriceType": "free",
    "description": "Apply for a marriage licence in person.",
    "displayName": "Marriage licence appointment",
    "duration_minutes": 30,
    "id": "57da6774-a087-4d69-b0e6-6fb82c339976",
    "isHiddenFromCustomers": false,
    "isLocationOnline": false,
    "maximumAttendeesCount": 1,
    "notes": "",
    "staffMemberIds": [
      "8ee1c803-a1fa-406d-8259-7ab53233f148"
    ],
    "webUrl": "https://outlook.office365.com/owa/calendar/Cityclerk@contoso.onmicrosoft.com/bookings/s/Q2g"
  }
}
```

### Get staff member

Get one staff member's details.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.
- Staff member (`staff_member_id`, text, required): The staff member.

**Outputs**

- `staff_member` (object): A member of the calendar's staff

**Example output**

```json
{
  "staff_member": {
    "displayName": "Dana Swope",
    "emailAddress": "danas@contoso.com",
    "id": "8ee1c803-a1fa-406d-8259-7ab53233f148",
    "isEmailNotificationEnabled": true,
    "membershipStatus": "active",
    "role": "administrator",
    "timeZone": "America/Chicago",
    "useBusinessHours": true
  }
}
```

### List appointments

List the appointments between two times, earliest first, optionally for one service, staff member or customer.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.
- From (`start_time`, date and time): List appointments from this time. Leave empty for now.
- To (`end_time`, date and time): List appointments up to this time. Leave empty for a week after the start.
- Service (`service_id`, text): Only this service's appointments. Leave empty for every service.
- Staff member (`staff_member_id`, text): Only appointments this staff member is booked for. Leave empty for everyone.
- Customer email (`customer_email`, text): Only this customer's appointments. Leave empty for every customer.

**Outputs**

- `appointments` (list): The appointments
- `count` (number): How many are returned

**Example output**

```json
{
  "appointments": [
    {
      "additionalInformation": "Bring photo ID for both applicants.",
      "createdDateTime": "2026-10-28T09:12:00Z",
      "customerEmailAddress": "jonis@relecloud.com",
      "customerName": "Joni Sherman",
      "customerNotes": "",
      "customerPhone": "206-555-0199",
      "customerTimeZone": "America/Chicago",
      "customers": [
        {
          "customerId": "36038f36-634e-44e4-9415-d7d59c2347aa",
          "emailAddress": "jonis@relecloud.com",
          "name": "Joni Sherman",
          "phone": "206-555-0199",
          "timeZone": "America/Chicago"
        }
      ],
      "duration_minutes": 30,
      "end_time": "2026-11-03T15:30:00Z",
      "id": "AAMkADc7zF4J0AAA8v_KnAAA=",
      "isLocationOnline": false,
      "joinWebUrl": "",
      "lastUpdatedDateTime": "2026-10-28T09:12:00Z",
      "optOutOfCustomerEmail": false,
      "price": 0,
      "priceType": "free",
      "selfServiceAppointmentId": "00000000-0000-0000-0000-000000000000",
      "serviceId": "57da6774-a087-4d69-b0e6-6fb82c339976",
      "serviceName": "Marriage licence appointment",
      "serviceNotes": "",
      "staffMemberIds": [
        "8ee1c803-a1fa-406d-8259-7ab53233f148"
      ],
      "start_time": "2026-11-03T15:00:00Z"
    }
  ],
  "count": 1
}
```

### List Bookings calendars

List the Bookings calendars in your organization.

**Inputs**

- Search (`search`, text): Only calendars whose name contains this. Leave empty for all.

**Outputs**

- `businesses` (list): The calendars, by id and name
- `count` (number): How many are returned

**Example output**

```json
{
  "businesses": [
    {
      "displayName": "City Clerk",
      "id": "Cityclerk@contoso.onmicrosoft.com"
    }
  ],
  "count": 1
}
```

### List custom questions

List the questions customers answer when they book.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.

**Outputs**

- `count` (number): How many are returned
- `questions` (list): The questions

**Example output**

```json
{
  "count": 1,
  "questions": [
    {
      "answerInputType": "radioButton",
      "answerOptions": [
        "Birth certificate",
        "Marriage certificate"
      ],
      "displayName": "Which document do you need?",
      "id": "3bc6fde0-4ad3-445d-ab17-0fc15dba0774"
    }
  ]
}
```

### List customers

List a Bookings calendar's customers, or find them by name, email or phone.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.
- Search (`search`, text): Only customers whose name, email or phone contains this. Leave empty for all.

**Outputs**

- `count` (number): How many are returned
- `customers` (list): The customers

**Example output**

```json
{
  "count": 1,
  "customers": [
    {
      "addresses": [
        {
          "city": "Buffalo",
          "countryOrRegion": "USA",
          "postalCode": "98052",
          "state": "NY",
          "street": "4567 Main Street"
        }
      ],
      "createdDateTime": "2026-10-01T15:02:11Z",
      "displayName": "Joni Sherman",
      "emailAddress": "jonis@relecloud.com",
      "id": "36038f36-634e-44e4-9415-d7d59c2347aa",
      "lastUpdatedDateTime": "2026-10-01T15:02:11Z",
      "phone": "206-555-0199",
      "phones": [
        {
          "number": "206-555-0199",
          "type": "mobile"
        }
      ]
    }
  ]
}
```

### List services

List the services a Bookings calendar offers, with their length and price.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.

**Outputs**

- `count` (number): How many are returned
- `services` (list): The services

**Example output**

```json
{
  "count": 1,
  "services": [
    {
      "additionalInformation": "Bring photo ID for both applicants.",
      "defaultDuration": "PT30M",
      "defaultPrice": 0,
      "defaultPriceType": "free",
      "description": "Apply for a marriage licence in person.",
      "displayName": "Marriage licence appointment",
      "duration_minutes": 30,
      "id": "57da6774-a087-4d69-b0e6-6fb82c339976",
      "isHiddenFromCustomers": false,
      "isLocationOnline": false,
      "maximumAttendeesCount": 1,
      "notes": "",
      "staffMemberIds": [
        "8ee1c803-a1fa-406d-8259-7ab53233f148"
      ],
      "webUrl": "https://outlook.office365.com/owa/calendar/Cityclerk@contoso.onmicrosoft.com/bookings/s/Q2g"
    }
  ]
}
```

### List staff

List a Bookings calendar's staff members and their roles.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.

**Outputs**

- `count` (number): How many are returned
- `staff_members` (list): The staff

**Example output**

```json
{
  "count": 1,
  "staff_members": [
    {
      "displayName": "Dana Swope",
      "emailAddress": "danas@contoso.com",
      "id": "8ee1c803-a1fa-406d-8259-7ab53233f148",
      "isEmailNotificationEnabled": true,
      "membershipStatus": "active",
      "role": "administrator",
      "timeZone": "America/Chicago",
      "useBusinessHours": true
    }
  ]
}
```

### Reschedule or update appointment

Move an appointment to a new time, or change its staff or staff notes. Moving the start alone keeps its length. Only the fields you fill in change.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.
- Appointment (`appointment_id`, text, required): The appointment. Pick one of the next 60 days', or use its id from List appointments or a trigger.
- New start time (`start_time`, date and time): When it starts now. Leave empty to keep it.
- New end time (`end_time`, date and time): When it ends now. Leave empty to keep its length.
- Staff (`staff_member_ids`, list): The staff booked for it now. Leave empty to keep them.
- Staff notes (`service_notes`, text): New notes for staff, replacing the old ones. Leave empty to keep them.

**Outputs**

- `appointment` (object): An appointment

**Example output**

```json
{
  "appointment": {
    "additionalInformation": "Bring photo ID for both applicants.",
    "createdDateTime": "2026-10-28T09:12:00Z",
    "customerEmailAddress": "jonis@relecloud.com",
    "customerName": "Joni Sherman",
    "customerNotes": "",
    "customerPhone": "206-555-0199",
    "customerTimeZone": "America/Chicago",
    "customers": [
      {
        "customerId": "36038f36-634e-44e4-9415-d7d59c2347aa",
        "emailAddress": "jonis@relecloud.com",
        "name": "Joni Sherman",
        "phone": "206-555-0199",
        "timeZone": "America/Chicago"
      }
    ],
    "duration_minutes": 30,
    "end_time": "2026-11-03T15:30:00Z",
    "id": "AAMkADc7zF4J0AAA8v_KnAAA=",
    "isLocationOnline": false,
    "joinWebUrl": "",
    "lastUpdatedDateTime": "2026-10-28T09:12:00Z",
    "optOutOfCustomerEmail": false,
    "price": 0,
    "priceType": "free",
    "selfServiceAppointmentId": "00000000-0000-0000-0000-000000000000",
    "serviceId": "57da6774-a087-4d69-b0e6-6fb82c339976",
    "serviceName": "Marriage licence appointment",
    "serviceNotes": "",
    "staffMemberIds": [
      "8ee1c803-a1fa-406d-8259-7ab53233f148"
    ],
    "start_time": "2026-11-03T15:00:00Z"
  }
}
```

### Update customer

Change a customer's name, email, phone or address. Only the fields you fill in change.

**Inputs**

- Bookings calendar (`business_id`, text, required): The Bookings calendar. Pick one, or paste its id.
- Customer (`customer_id`, text, required): The customer.
- Name (`name`, text): The customer's new name. Leave empty to keep it.
- Email (`email`, text): The customer's email address. Leave empty to keep it.
- Phone (`phone`, text): The customer's phone number. It replaces their number of the same type.
- Phone type (`phone_type`, text): What kind of number it is. One of: `mobile`, `home`, `business`, `other`. Default: `mobile`.
- Street (`street`, text): The street address. Leave empty to keep it.
- City (`city`, text): The city. Leave empty to keep it.
- State (`state`, text): The state or province. Leave empty to keep it.
- Postal code (`postal_code`, text): The postal code. Leave empty to keep it.
- Country (`country`, text): The country or region. Leave empty to keep it.

**Outputs**

- `customer` (object): A customer

**Example output**

```json
{
  "customer": {
    "addresses": [
      {
        "city": "Buffalo",
        "countryOrRegion": "USA",
        "postalCode": "98052",
        "state": "NY",
        "street": "4567 Main Street"
      }
    ],
    "createdDateTime": "2026-10-01T15:02:11Z",
    "displayName": "Joni Sherman",
    "emailAddress": "jonis@relecloud.com",
    "id": "36038f36-634e-44e4-9415-d7d59c2347aa",
    "lastUpdatedDateTime": "2026-10-01T15:02:11Z",
    "phone": "206-555-0199",
    "phones": [
      {
        "number": "206-555-0199",
        "type": "mobile"
      }
    ]
  }
}
```
