# SimplyBook.me

> Online booking and appointment scheduling. List, create, reschedule and cancel bookings, find free time slots, manage clients, read your services and staff, block time with calendar notes, and get booking statistics.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/simplybook

## Actions

### Cancel booking

Cancel a booking. SimplyBook keeps it, marked canceled, and frees its time slot.

**Inputs**

- Booking (`booking_id`, text, required): The booking's id. Use 'List bookings' to find one, or chain it from 'Create booking'.

**Outputs**

- `booking` (object): The canceled booking
- `booking_id` (text)
- `canceled` (true/false)

**Example output**

```json
{
  "booking": {
    "additional_fields": [],
    "can_be_canceled": true,
    "can_be_edited": true,
    "category_id": null,
    "client": {
      "address1": null,
      "address2": null,
      "email": "jamie@example.com",
      "id": "41",
      "name": "Jamie Rivera",
      "phone": "+15555550123"
    },
    "client_id": "41",
    "code": "1jx2b7q9",
    "comment": "",
    "duration": 60,
    "end_datetime": "2026-11-02 11:00:00",
    "id": "128",
    "is_confirmed": true,
    "is_sequential": false,
    "location_id": null,
    "log": [],
    "provider": {
      "color": "#3a87ad",
      "description": "",
      "email": "alex@example.com",
      "id": "2",
      "is_active": true,
      "is_visible": true,
      "name": "Alex Morgan",
      "phone": "+15555550100",
      "picture": null,
      "picture_preview": null,
      "qty": 1,
      "services": [
        "3"
      ]
    },
    "provider_id": "2",
    "resources": [],
    "service": {
      "buffer_time_after": 0,
      "currency": "USD",
      "deposit_price": 0,
      "description": "A 60-minute consultation.",
      "duration": 60,
      "id": "3",
      "is_active": true,
      "is_visible": true,
      "limit_booking": 0,
      "memberships": [],
      "min_group_booking": 1,
      "name": "Consultation",
      "picture": null,
      "picture_preview": null,
      "price": 50,
      "providers": [
        "2"
      ],
      "tax": null,
      "tax_id": null
    },
    "service_id": "3",
    "start_datetime": "2026-11-02 10:00:00",
    "status": "canceled"
  },
  "booking_id": "128",
  "canceled": true
}
```

### Create booking

Book a client in for a service with a provider at a given time. Use 'Get first available slot' for a time that is free. Returns the new booking and its id.

**Inputs**

- Service (`service_id`, text, required): The service to book.
- Service provider (`service_provider_id`, text, required): The staff member or resource who provides the service.
- Client (`client_id`, text, required): The client's id. Use 'List clients' to find one, or chain it from 'Create client'.
- Start (`start_datetime`, date and time, required): When the booking starts. Typed as YYYY-MM-DD HH:MM it is taken as company time; a picked time is converted to the connection's time zone.
- End (`end_datetime`, date and time): When it ends. Leave empty to use the service's duration. Typed as YYYY-MM-DD HH:MM it is taken as company time; a picked time is converted to the connection's time zone.
- Places (`count`, number): How many places to book in one go, for group services. Defaults to 1. From 1 to 1000. Default: `1`.
- Intake form answers (`additional_fields`, object): Answers to the booking form's extra fields, as field name and value, for example {"Reason for visit": "Check-up"}.
- Skip membership (`skip_membership`, true/false): Turn on to book without using the client's membership. Default: `false`.
- Accept payment (`accept_payment`, true/false): Turn on to ask the client to pay when the service has a price. Default: `false`.

**Outputs**

- `batch` (object): The group the bookings belong to, if any
- `booking` (object): The first booking made
- `booking_id` (text): Id of the first booking made
- `bookings` (list): Every booking made (several for a group or recurring booking)

**Example output**

```json
{
  "batch": null,
  "booking": {
    "category_id": null,
    "client_id": "41",
    "code": "1jx2b7q9",
    "duration": 60,
    "end_datetime": "2026-11-02 11:00:00",
    "id": "128",
    "is_confirmed": true,
    "is_sequential": false,
    "location_id": null,
    "provider": {
      "color": "#3a87ad",
      "description": "",
      "email": "alex@example.com",
      "id": "2",
      "is_active": true,
      "is_visible": true,
      "name": "Alex Morgan",
      "phone": "+15555550100",
      "picture": null,
      "picture_preview": null,
      "qty": 1,
      "services": [
        "3"
      ]
    },
    "provider_id": "2",
    "service": {
      "buffer_time_after": 0,
      "currency": "USD",
      "deposit_price": 0,
      "description": "A 60-minute consultation.",
      "duration": 60,
      "id": "3",
      "is_active": true,
      "is_visible": true,
      "limit_booking": 0,
      "memberships": [],
      "min_group_booking": 1,
      "name": "Consultation",
      "picture": null,
      "picture_preview": null,
      "price": 50,
      "providers": [
        "2"
      ],
      "tax": null,
      "tax_id": null
    },
    "service_id": "3",
    "start_datetime": "2026-11-02 10:00:00"
  },
  "booking_id": "128",
  "bookings": [
    {
      "category_id": null,
      "client_id": "41",
      "code": "1jx2b7q9",
      "duration": 60,
      "end_datetime": "2026-11-02 11:00:00",
      "id": "128",
      "is_confirmed": true,
      "is_sequential": false,
      "location_id": null,
      "provider": {
        "color": "#3a87ad",
        "description": "",
        "email": "alex@example.com",
        "id": "2",
        "is_active": true,
        "is_visible": true,
        "name": "Alex Morgan",
        "phone": "+15555550100",
        "picture": null,
        "picture_preview": null,
        "qty": 1,
        "services": [
          "3"
        ]
      },
      "provider_id": "2",
      "service": {
        "buffer_time_after": 0,
        "currency": "USD",
        "deposit_price": 0,
        "description": "A 60-minute consultation.",
        "duration": 60,
        "id": "3",
        "is_active": true,
        "is_visible": true,
        "limit_booking": 0,
        "memberships": [],
        "min_group_booking": 1,
        "name": "Consultation",
        "picture": null,
        "picture_preview": null,
        "price": 50,
        "providers": [
          "2"
        ],
        "tax": null,
        "tax_id": null
      },
      "service_id": "3",
      "start_datetime": "2026-11-02 10:00:00"
    }
  ]
}
```

### Create calendar note

Put a note on the SimplyBook calendar for a stretch of time, for everyone, one provider or one service. Turn on 'Block time' to stop clients booking during it.

**Inputs**

- Start (`start_datetime`, date and time, required): When the note starts. Typed as YYYY-MM-DD HH:MM it is taken as company time; a picked time is converted to the connection's time zone.
- End (`end_datetime`, date and time, required): When the note ends. Typed as YYYY-MM-DD HH:MM it is taken as company time; a picked time is converted to the connection's time zone.
- Note (`note`, text, required): What the note says.
- Applies to (`note_mode`, text): Who the note is for. One of: `all` (Everyone), `provider` (One service provider), `service` (One service). Default: `all`.
- Service provider (`service_provider_id`, text): The provider the note is for. Only when Applies to is One service provider.
- Service (`service_id`, text): The service the note is for. Only when Applies to is One service.
- Note type (`note_type_id`, text): The kind of note, which sets its colour. Leave empty for the default type.
- Block time (`time_blocked`, true/false): Turn on to stop clients booking during the note. Default: `false`.

**Outputs**

- `end_date_time` (text)
- `id` (text)
- `mode` (text)
- `note` (text)
- `note_type` (object)
- `note_type_id` (text)
- `provider` (object)
- `provider_id` (text)
- `service` (object)
- `service_id` (text)
- `start_date_time` (text)
- `time_blocked` (true/false)

**Example output**

```json
{
  "end_date_time": "2026-12-24 17:00:00",
  "id": "7",
  "mode": "all",
  "note": "Office closed",
  "note_type": {
    "color": "#ffcc00",
    "id": "1",
    "is_default": true,
    "name": "Note",
    "position": null
  },
  "note_type_id": "1",
  "provider": null,
  "provider_id": null,
  "service": null,
  "service_id": null,
  "start_date_time": "2026-12-24 09:00:00",
  "time_blocked": true
}
```

### Create client

Add a client. Which of email and phone are required depends on your SimplyBook settings. Returns the new client and its id.

**Inputs**

- Name (`name`, text, required): The client's full name.
- Email (`email`, text): The client's email address.
- Phone (`phone`, text): The client's phone number, with country code.
- Address line 1 (`address1`, text): Street address. Only kept when the Client Login custom feature is on in SimplyBook.
- Address line 2 (`address2`, text): Second address line. Only kept when the Client Login custom feature is on in SimplyBook.
- City (`city`, text): City. Only kept when the Client Login custom feature is on in SimplyBook.
- Postcode (`zip_code`, text): Postcode or ZIP code. Only kept when the Client Login custom feature is on in SimplyBook.
- Country code (`country_id`, text): Two-letter country code, such as US or GB. Only kept when the Client Login custom feature is on in SimplyBook.
- State id (`state_id`, text): SimplyBook's numeric id for the state or region. Only kept when the Client Login custom feature is on in SimplyBook.

**Outputs**

- `address1` (text)
- `address2` (text)
- `can_be_edited` (true/false)
- `city` (text)
- `country_id` (text)
- `email` (text)
- `email_promo_subscribed` (true/false)
- `id` (text)
- `is_deleted` (true/false)
- `name` (text)
- `phone` (text)
- `sms_promo_subscribed` (true/false)
- `state_id` (text)
- `zip` (text)

**Example output**

```json
{
  "address1": null,
  "address2": null,
  "can_be_edited": true,
  "city": null,
  "country_id": null,
  "email": "jamie@example.com",
  "email_promo_subscribed": false,
  "id": "41",
  "is_deleted": false,
  "name": "Jamie Rivera",
  "phone": "+15555550123",
  "sms_promo_subscribed": false,
  "state_id": null,
  "zip": null
}
```

### Delete calendar note

Delete a note from the SimplyBook calendar, freeing any time it blocked.

**Inputs**

- Calendar note (`note_id`, text, required): The note's id. Use 'List calendar notes' to find one, or chain it from 'Create calendar note'.

**Outputs**

- `deleted` (true/false)
- `note_id` (text)

**Example output**

```json
{
  "deleted": true,
  "note_id": "7"
}
```

### Delete client

Delete a client from SimplyBook.

**Inputs**

- Client (`client_id`, text, required): The client's id. Use 'List clients' to find one, or chain it from 'Create client'.

**Outputs**

- `client_id` (text)
- `deleted` (true/false)

**Example output**

```json
{
  "client_id": "41",
  "deleted": true
}
```

### Get available slots

List the start times still free on one day for a service with a provider. Each slot carries a start time ready for 'Create booking'.

**Inputs**

- Service (`service_id`, text, required): The service to book.
- Service provider (`service_provider_id`, text, required): The staff member or resource who provides the service.
- Date (`date`, date, required): The day to look at, in company time.
- Places (`count`, number): How many places to book in one go, for group services. Defaults to 1. From 1 to 1000. Default: `1`.

**Outputs**

- `count` (number)
- `date` (text)
- `slots` (list): Free slots

**Example output**

```json
{
  "count": 1,
  "date": "2026-11-02",
  "slots": [
    {
      "date": "2026-11-02",
      "id": "2026-11-02",
      "start_datetime": "2026-11-02 10:00:00",
      "time": "10:00:00"
    }
  ]
}
```

### Get booking

Get one booking with everything SimplyBook holds on it: times, status, service, provider, client, comment, intake form answers and its change log.

**Inputs**

- Booking (`booking_id`, text, required): The booking's id. Use 'List bookings' to find one, or chain it from 'Create booking'.

**Outputs**

- `additional_fields` (list)
- `can_be_canceled` (true/false)
- `can_be_edited` (true/false)
- `category_id` (text)
- `client` (object)
- `client_id` (text)
- `code` (text)
- `comment` (text)
- `duration` (number)
- `end_datetime` (text)
- `id` (text)
- `invoice_datetime` (text)
- `invoice_id` (text)
- `invoice_number` (text)
- `invoice_payment_processor` (text)
- `invoice_status` (text)
- `is_confirmed` (true/false)
- `is_sequential` (true/false)
- `location_id` (text)
- `log` (list)
- `membership_id` (text)
- `provider` (object)
- `provider_id` (text)
- `resources` (list)
- `service` (object)
- `service_id` (text)
- `start_datetime` (text)
- `status` (text)
- `ticket_code` (text)
- `ticket_is_used` (true/false)
- `ticket_validation_datetime` (text)
- `user_status_id` (text)

**Example output**

```json
{
  "additional_fields": [],
  "can_be_canceled": true,
  "can_be_edited": true,
  "category_id": null,
  "client": {
    "address1": null,
    "address2": null,
    "email": "jamie@example.com",
    "id": "41",
    "name": "Jamie Rivera",
    "phone": "+15555550123"
  },
  "client_id": "41",
  "code": "1jx2b7q9",
  "comment": "",
  "duration": 60,
  "end_datetime": "2026-11-02 11:00:00",
  "id": "128",
  "is_confirmed": true,
  "is_sequential": false,
  "location_id": null,
  "log": [],
  "provider": {
    "color": "#3a87ad",
    "description": "",
    "email": "alex@example.com",
    "id": "2",
    "is_active": true,
    "is_visible": true,
    "name": "Alex Morgan",
    "phone": "+15555550100",
    "picture": null,
    "picture_preview": null,
    "qty": 1,
    "services": [
      "3"
    ]
  },
  "provider_id": "2",
  "resources": [],
  "service": {
    "buffer_time_after": 0,
    "currency": "USD",
    "deposit_price": 0,
    "description": "A 60-minute consultation.",
    "duration": 60,
    "id": "3",
    "is_active": true,
    "is_visible": true,
    "limit_booking": 0,
    "memberships": [],
    "min_group_booking": 1,
    "name": "Consultation",
    "picture": null,
    "picture_preview": null,
    "price": 50,
    "providers": [
      "2"
    ],
    "tax": null,
    "tax_id": null
  },
  "service_id": "3",
  "start_datetime": "2026-11-02 10:00:00",
  "status": "confirmed"
}
```

### Get booking links

Get the links a client uses to view, cancel or reschedule a booking, ready to send in a message. The reschedule link is empty unless the Reschedule custom feature is on.

**Inputs**

- Booking (`booking_id`, text, required): The booking's id. Use 'List bookings' to find one, or chain it from 'Create booking'.

**Outputs**

- `booking_id` (text)
- `booking_link` (text)
- `cancel_link` (text)
- `reschedule_link` (text)

**Example output**

```json
{
  "booking_id": "128",
  "booking_link": "https://mycompany.simplybook.me/v2/#booking/128",
  "cancel_link": "https://mycompany.simplybook.me/v2/#cancel/128",
  "reschedule_link": ""
}
```

### Get client

Get one client's contact details and marketing preferences.

**Inputs**

- Client (`client_id`, text, required): The client's id. Use 'List clients' to find one, or chain it from 'Create client'.

**Outputs**

- `address1` (text)
- `address2` (text)
- `can_be_edited` (true/false)
- `city` (text)
- `country_id` (text)
- `email` (text)
- `email_promo_subscribed` (true/false)
- `id` (text)
- `is_deleted` (true/false)
- `name` (text)
- `phone` (text)
- `sms_promo_subscribed` (true/false)
- `state_id` (text)
- `zip` (text)

**Example output**

```json
{
  "address1": null,
  "address2": null,
  "can_be_edited": true,
  "city": null,
  "country_id": null,
  "email": "jamie@example.com",
  "email_promo_subscribed": false,
  "id": "41",
  "is_deleted": false,
  "name": "Jamie Rivera",
  "phone": "+15555550123",
  "sms_promo_subscribed": false,
  "state_id": null,
  "zip": null
}
```

### Get first available slot

Find the first free start time for a service with a provider on or after a day; SimplyBook looks at later days when that one is full. 'found' is false when nothing is free.

**Inputs**

- Service (`service_id`, text, required): The service to book.
- Service provider (`service_provider_id`, text, required): The staff member or resource who provides the service.
- Date (`date`, date, required): The day to look at, in company time.
- Places (`count`, number): How many places to book in one go, for group services. Defaults to 1. From 1 to 1000. Default: `1`.

**Outputs**

- `date` (text): YYYY-MM-DD
- `found` (true/false): Whether a free slot was found
- `id` (text)
- `start_datetime` (text): YYYY-MM-DD HH:MM:SS, ready for a booking's start time
- `time` (text): HH:MM:SS, company time

**Example output**

```json
{
  "date": "2026-11-02",
  "found": true,
  "id": "2026-11-02",
  "start_datetime": "2026-11-02 10:00:00",
  "time": "10:00:00"
}
```

### Get statistics

Get the dashboard figures: bookings today, this week and this month, and the most booked service and provider.

**Inputs**: None.

**Outputs**

- `bookings` (number): Bookings this month
- `bookings_this_week` (number)
- `bookings_today` (number)
- `most_popular_provider` (object)
- `most_popular_provider_bookings` (number)
- `most_popular_service` (object)
- `most_popular_service_bookings` (number)

**Example output**

```json
{
  "bookings": 41,
  "bookings_this_week": 14,
  "bookings_today": 3,
  "most_popular_provider": {
    "color": "#3a87ad",
    "description": "",
    "email": "alex@example.com",
    "id": "2",
    "is_active": true,
    "is_visible": true,
    "name": "Alex Morgan",
    "phone": "+15555550100",
    "picture": null,
    "picture_preview": null,
    "qty": 1,
    "services": [
      "3"
    ]
  },
  "most_popular_provider_bookings": 12,
  "most_popular_service": {
    "buffer_time_after": 0,
    "currency": "USD",
    "deposit_price": 0,
    "description": "A 60-minute consultation.",
    "duration": 60,
    "id": "3",
    "is_active": true,
    "is_visible": true,
    "limit_booking": 0,
    "memberships": [],
    "min_group_booking": 1,
    "name": "Consultation",
    "picture": null,
    "picture_preview": null,
    "price": 50,
    "providers": [
      "2"
    ],
    "tax": null,
    "tax_id": null
  },
  "most_popular_service_bookings": 9
}
```

### List bookings

List bookings, filtered by status, service, provider, client, day or date range, or by text in the booking code or client details. Returns each booking with its times, status, service, provider and client.

**Inputs**

- Status (`status`, text): Only bookings with this status. One of: `confirmed`, `confirmed_pending` (Confirmed or pending), `pending`, `canceled`.
- Upcoming only (`upcoming_only`, true/false): Turn on to leave out bookings that have passed. Default: `false`.
- Services (`service_ids`, list): Only bookings for these services.
- Service providers (`service_provider_ids`, list): Only bookings with these providers.
- Client (`client_id`, text): Only this client's bookings. Use 'List clients' to find the id.
- On date (`date`, date): Only bookings on this day.
- From date (`date_from`, date): Only bookings on or after this day.
- To date (`date_to`, date): Only bookings on or before this day.
- Search (`search`, text): Only bookings whose code or client details contain this text.
- Maximum results (`max_results`, number): How many records to return, 1-500. Defaults to 50. From 1 to 500. Default: `50`.

**Outputs**

- `bookings` (list): Matching bookings
- `count` (number): Records returned
- `has_more` (true/false): Whether more match than were returned
- `total_count` (number): Records matching, in all

**Example output**

```json
{
  "bookings": [
    {
      "can_be_canceled": true,
      "can_be_edited": true,
      "category_id": null,
      "client": {
        "address1": null,
        "address2": null,
        "email": "jamie@example.com",
        "id": "41",
        "name": "Jamie Rivera",
        "phone": "+15555550123"
      },
      "client_id": "41",
      "code": "1jx2b7q9",
      "duration": 60,
      "end_datetime": "2026-11-02 11:00:00",
      "id": "128",
      "is_confirmed": true,
      "is_sequential": false,
      "location_id": null,
      "provider": {
        "color": "#3a87ad",
        "description": "",
        "email": "alex@example.com",
        "id": "2",
        "is_active": true,
        "is_visible": true,
        "name": "Alex Morgan",
        "phone": "+15555550100",
        "picture": null,
        "picture_preview": null,
        "qty": 1,
        "services": [
          "3"
        ]
      },
      "provider_id": "2",
      "service": {
        "buffer_time_after": 0,
        "currency": "USD",
        "deposit_price": 0,
        "description": "A 60-minute consultation.",
        "duration": 60,
        "id": "3",
        "is_active": true,
        "is_visible": true,
        "limit_booking": 0,
        "memberships": [],
        "min_group_booking": 1,
        "name": "Consultation",
        "picture": null,
        "picture_preview": null,
        "price": 50,
        "providers": [
          "2"
        ],
        "tax": null,
        "tax_id": null
      },
      "service_id": "3",
      "start_datetime": "2026-11-02 10:00:00",
      "status": "confirmed"
    }
  ],
  "count": 1,
  "has_more": false,
  "total_count": 1
}
```

### List calendar notes

List notes and blocked-off time on the SimplyBook calendar, filtered by provider, service, note type, text or dates.

**Inputs**

- Service providers (`service_provider_ids`, list): Only notes for these providers.
- Services (`service_ids`, list): Only notes for these services.
- Note types (`note_type_ids`, list): Only notes of these types.
- Search (`search`, text): Only notes containing this text.
- From date (`date_from`, date): Only notes on or after this day.
- To date (`date_to`, date): Only notes on or before this day.
- Maximum results (`max_results`, number): How many records to return, 1-500. Defaults to 50. From 1 to 500. Default: `50`.

**Outputs**

- `count` (number): Records returned
- `has_more` (true/false): Whether more match than were returned
- `notes` (list): Matching notes
- `total_count` (number): Records matching, in all

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "notes": [
    {
      "end_date_time": "2026-12-24 17:00:00",
      "id": "7",
      "mode": "all",
      "note": "Office closed",
      "note_type": {
        "color": "#ffcc00",
        "id": "1",
        "is_default": true,
        "name": "Note",
        "position": null
      },
      "note_type_id": "1",
      "provider": null,
      "provider_id": null,
      "service": null,
      "service_id": null,
      "start_date_time": "2026-12-24 09:00:00",
      "time_blocked": true
    }
  ],
  "total_count": 1
}
```

### List clients

List clients, optionally only those whose name, email or phone contains some text. Returns each client's contact details.

**Inputs**

- Search (`search`, text): Only return records matching this text.
- Maximum results (`max_results`, number): How many records to return, 1-500. Defaults to 50. From 1 to 500. Default: `50`.

**Outputs**

- `clients` (list): Matching clients
- `count` (number): Records returned
- `has_more` (true/false): Whether more match than were returned
- `total_count` (number): Records matching, in all

**Example output**

```json
{
  "clients": [
    {
      "address1": null,
      "address2": null,
      "can_be_edited": true,
      "city": null,
      "country_id": null,
      "email": "jamie@example.com",
      "email_promo_subscribed": false,
      "id": "41",
      "is_deleted": false,
      "name": "Jamie Rivera",
      "phone": "+15555550123",
      "sms_promo_subscribed": false,
      "state_id": null,
      "zip": null
    }
  ],
  "count": 1,
  "has_more": false,
  "total_count": 1
}
```

### List service providers

List the staff members and resources who provide services, optionally only those who offer one service.

**Inputs**

- Search (`search`, text): Only return records matching this text.
- Service (`service_id`, text): Only providers who offer this service.
- Maximum results (`max_results`, number): How many records to return, 1-500. Defaults to 50. From 1 to 500. Default: `50`.

**Outputs**

- `count` (number): Records returned
- `has_more` (true/false): Whether more match than were returned
- `providers` (list): Matching service providers
- `total_count` (number): Records matching, in all

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "providers": [
    {
      "color": "#3a87ad",
      "description": "",
      "email": "alex@example.com",
      "id": "2",
      "is_active": true,
      "is_visible": true,
      "name": "Alex Morgan",
      "phone": "+15555550100",
      "picture": null,
      "picture_preview": null,
      "qty": 1,
      "services": [
        "3"
      ]
    }
  ],
  "total_count": 1
}
```

### List services

List the services clients can book, with each one's price, duration and the providers who offer it.

**Inputs**

- Search (`search`, text): Only return records matching this text.
- Maximum results (`max_results`, number): How many records to return, 1-500. Defaults to 50. From 1 to 500. Default: `50`.

**Outputs**

- `count` (number): Records returned
- `has_more` (true/false): Whether more match than were returned
- `services` (list): Matching services
- `total_count` (number): Records matching, in all

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "services": [
    {
      "buffer_time_after": 0,
      "currency": "USD",
      "deposit_price": 0,
      "description": "A 60-minute consultation.",
      "duration": 60,
      "id": "3",
      "is_active": true,
      "is_visible": true,
      "limit_booking": 0,
      "memberships": [],
      "min_group_booking": 1,
      "name": "Consultation",
      "picture": null,
      "picture_preview": null,
      "price": 50,
      "providers": [
        "2"
      ],
      "tax": null,
      "tax_id": null
    }
  ],
  "total_count": 1
}
```

### Set booking comment

Replace a booking's internal comment, which staff see in the SimplyBook calendar. Send empty text to clear it.

**Inputs**

- Booking (`booking_id`, text, required): The booking's id. Use 'List bookings' to find one, or chain it from 'Create booking'.
- Comment (`comment`, text, required): The new comment. It replaces any comment already there.

**Outputs**

- `additional_fields` (list)
- `can_be_canceled` (true/false)
- `can_be_edited` (true/false)
- `category_id` (text)
- `client` (object)
- `client_id` (text)
- `code` (text)
- `comment` (text)
- `duration` (number)
- `end_datetime` (text)
- `id` (text)
- `invoice_datetime` (text)
- `invoice_id` (text)
- `invoice_number` (text)
- `invoice_payment_processor` (text)
- `invoice_status` (text)
- `is_confirmed` (true/false)
- `is_sequential` (true/false)
- `location_id` (text)
- `log` (list)
- `membership_id` (text)
- `provider` (object)
- `provider_id` (text)
- `resources` (list)
- `service` (object)
- `service_id` (text)
- `start_datetime` (text)
- `status` (text)
- `ticket_code` (text)
- `ticket_is_used` (true/false)
- `ticket_validation_datetime` (text)
- `user_status_id` (text)

**Example output**

```json
{
  "additional_fields": [],
  "can_be_canceled": true,
  "can_be_edited": true,
  "category_id": null,
  "client": {
    "address1": null,
    "address2": null,
    "email": "jamie@example.com",
    "id": "41",
    "name": "Jamie Rivera",
    "phone": "+15555550123"
  },
  "client_id": "41",
  "code": "1jx2b7q9",
  "comment": "Prefers mornings.",
  "duration": 60,
  "end_datetime": "2026-11-02 11:00:00",
  "id": "128",
  "is_confirmed": true,
  "is_sequential": false,
  "location_id": null,
  "log": [],
  "provider": {
    "color": "#3a87ad",
    "description": "",
    "email": "alex@example.com",
    "id": "2",
    "is_active": true,
    "is_visible": true,
    "name": "Alex Morgan",
    "phone": "+15555550100",
    "picture": null,
    "picture_preview": null,
    "qty": 1,
    "services": [
      "3"
    ]
  },
  "provider_id": "2",
  "resources": [],
  "service": {
    "buffer_time_after": 0,
    "currency": "USD",
    "deposit_price": 0,
    "description": "A 60-minute consultation.",
    "duration": 60,
    "id": "3",
    "is_active": true,
    "is_visible": true,
    "limit_booking": 0,
    "memberships": [],
    "min_group_booking": 1,
    "name": "Consultation",
    "picture": null,
    "picture_preview": null,
    "price": 50,
    "providers": [
      "2"
    ],
    "tax": null,
    "tax_id": null
  },
  "service_id": "3",
  "start_datetime": "2026-11-02 10:00:00",
  "status": "confirmed"
}
```

### Update booking

Reschedule a booking or change its service, provider or client. Fields left empty keep their current values; a new start without a new end keeps the service's duration.

**Inputs**

- Booking (`booking_id`, text, required): The booking's id. Use 'List bookings' to find one, or chain it from 'Create booking'.
- Service (`service_id`, text): A different service. Leave empty to keep it.
- Service provider (`service_provider_id`, text): A different provider. Leave empty to keep them.
- Client (`client_id`, text): A different client. Leave empty to keep them.
- Start (`start_datetime`, date and time): A new start time. Leave empty to keep it. Typed as YYYY-MM-DD HH:MM it is taken as company time; a picked time is converted to the connection's time zone.
- End (`end_datetime`, date and time): A new end time. Leave empty to keep the service's duration. Typed as YYYY-MM-DD HH:MM it is taken as company time; a picked time is converted to the connection's time zone.
- Places (`count`, number): How many places to book in one go, for group services. Defaults to 1. From 1 to 1000. Default: `1`.
- Intake form answers (`additional_fields`, object): Answers to the booking form's extra fields, as field name and value, for example {"Reason for visit": "Check-up"}.

**Outputs**

- `batch` (object): The group the bookings belong to, if any
- `booking` (object): The first booking made
- `booking_id` (text): Id of the first booking made
- `bookings` (list): Every booking made (several for a group or recurring booking)

**Example output**

```json
{
  "batch": null,
  "booking": {
    "category_id": null,
    "client_id": "41",
    "code": "1jx2b7q9",
    "duration": 60,
    "end_datetime": "2026-11-02 11:00:00",
    "id": "128",
    "is_confirmed": true,
    "is_sequential": false,
    "location_id": null,
    "provider": {
      "color": "#3a87ad",
      "description": "",
      "email": "alex@example.com",
      "id": "2",
      "is_active": true,
      "is_visible": true,
      "name": "Alex Morgan",
      "phone": "+15555550100",
      "picture": null,
      "picture_preview": null,
      "qty": 1,
      "services": [
        "3"
      ]
    },
    "provider_id": "2",
    "service": {
      "buffer_time_after": 0,
      "currency": "USD",
      "deposit_price": 0,
      "description": "A 60-minute consultation.",
      "duration": 60,
      "id": "3",
      "is_active": true,
      "is_visible": true,
      "limit_booking": 0,
      "memberships": [],
      "min_group_booking": 1,
      "name": "Consultation",
      "picture": null,
      "picture_preview": null,
      "price": 50,
      "providers": [
        "2"
      ],
      "tax": null,
      "tax_id": null
    },
    "service_id": "3",
    "start_datetime": "2026-11-02 10:00:00"
  },
  "booking_id": "128",
  "bookings": [
    {
      "category_id": null,
      "client_id": "41",
      "code": "1jx2b7q9",
      "duration": 60,
      "end_datetime": "2026-11-02 11:00:00",
      "id": "128",
      "is_confirmed": true,
      "is_sequential": false,
      "location_id": null,
      "provider": {
        "color": "#3a87ad",
        "description": "",
        "email": "alex@example.com",
        "id": "2",
        "is_active": true,
        "is_visible": true,
        "name": "Alex Morgan",
        "phone": "+15555550100",
        "picture": null,
        "picture_preview": null,
        "qty": 1,
        "services": [
          "3"
        ]
      },
      "provider_id": "2",
      "service": {
        "buffer_time_after": 0,
        "currency": "USD",
        "deposit_price": 0,
        "description": "A 60-minute consultation.",
        "duration": 60,
        "id": "3",
        "is_active": true,
        "is_visible": true,
        "limit_booking": 0,
        "memberships": [],
        "min_group_booking": 1,
        "name": "Consultation",
        "picture": null,
        "picture_preview": null,
        "price": 50,
        "providers": [
          "2"
        ],
        "tax": null,
        "tax_id": null
      },
      "service_id": "3",
      "start_datetime": "2026-11-02 10:00:00"
    }
  ]
}
```

### Update client

Change a client's details. Fields left empty keep their current values.

**Inputs**

- Client (`client_id`, text, required): The client's id. Use 'List clients' to find one, or chain it from 'Create client'.
- Name (`name`, text): The client's full name. Leave empty to keep it.
- Email (`email`, text): The client's email address. Leave empty to keep it.
- Phone (`phone`, text): The client's phone number, with country code. Leave empty to keep it.
- Address line 1 (`address1`, text): Street address. Only kept when the Client Login custom feature is on in SimplyBook.
- Address line 2 (`address2`, text): Second address line. Only kept when the Client Login custom feature is on in SimplyBook.
- City (`city`, text): City. Only kept when the Client Login custom feature is on in SimplyBook.
- Postcode (`zip_code`, text): Postcode or ZIP code. Only kept when the Client Login custom feature is on in SimplyBook.
- Country code (`country_id`, text): Two-letter country code, such as US or GB. Only kept when the Client Login custom feature is on in SimplyBook.
- State id (`state_id`, text): SimplyBook's numeric id for the state or region. Only kept when the Client Login custom feature is on in SimplyBook.

**Outputs**

- `address1` (text)
- `address2` (text)
- `can_be_edited` (true/false)
- `city` (text)
- `country_id` (text)
- `email` (text)
- `email_promo_subscribed` (true/false)
- `id` (text)
- `is_deleted` (true/false)
- `name` (text)
- `phone` (text)
- `sms_promo_subscribed` (true/false)
- `state_id` (text)
- `zip` (text)

**Example output**

```json
{
  "address1": null,
  "address2": null,
  "can_be_edited": true,
  "city": null,
  "country_id": null,
  "email": "jamie@example.com",
  "email_promo_subscribed": false,
  "id": "41",
  "is_deleted": false,
  "name": "Jamie Rivera",
  "phone": "+15555550123",
  "sms_promo_subscribed": false,
  "state_id": null,
  "zip": null
}
```
