SimplyBook.me

App · 20 actions

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.

Actions

ActionWhat it does
Cancel bookingCancel a booking.
Create bookingBook a client in for a service with a provider at a given time.
Create calendar notePut a note on the SimplyBook calendar for a stretch of time, for everyone, one provider or one service.
Create clientAdd a client.
Delete calendar noteDelete a note from the SimplyBook calendar, freeing any time it blocked.
Delete clientDelete a client from SimplyBook.
Get available slotsList the start times still free on one day for a service with a provider.
Get bookingGet one booking with everything SimplyBook holds on it: times, status, service, provider, client, comment, intake form answers and its change log.
Get booking linksGet the links a client uses to view, cancel or reschedule a booking, ready to send in a message.
Get clientGet one client's contact details and marketing preferences.
Get first available slotFind 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.
Get statisticsGet the dashboard figures: bookings today, this week and this month, and the most booked service and provider.
List bookingsList bookings, filtered by status, service, provider, client, day or date range, or by text in the booking code or client details.
List calendar notesList notes and blocked-off time on the SimplyBook calendar, filtered by provider, service, note type, text or dates.
List clientsList clients, optionally only those whose name, email or phone contains some text.
List service providersList the staff members and resources who provide services, optionally only those who offer one service.
List servicesList the services clients can book, with each one's price, duration and the providers who offer it.
Set booking commentReplace a booking's internal comment, which staff see in the SimplyBook calendar.
Update bookingReschedule a booking or change its service, provider or client.
Update clientChange a client's details.

Cancel booking

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

Inputs

Bookingbooking_idtextRequired
The booking's id. Use 'List bookings' to find one, or chain it from 'Create booking'.

Outputs

bookingobject
The canceled booking
booking_idtext
canceledtrue/false
Example output
{
  "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

Serviceservice_idtextRequired
The service to book.
Service providerservice_provider_idtextRequired
The staff member or resource who provides the service.
Clientclient_idtextRequired
The client's id. Use 'List clients' to find one, or chain it from 'Create client'.
Startstart_datetimedate and timeRequired
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.
Endend_datetimedate 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.
Placescountnumber
How many places to book in one go, for group services. Defaults to 1.From 1 to 1000. Default: 1.
Intake form answersadditional_fieldsobject
Answers to the booking form's extra fields, as field name and value, for example {"Reason for visit": "Check-up"}.
Skip membershipskip_membershiptrue/false
Turn on to book without using the client's membership.Default: false.
Accept paymentaccept_paymenttrue/false
Turn on to ask the client to pay when the service has a price.Default: false.

Outputs

batchobject
The group the bookings belong to, if any
bookingobject
The first booking made
booking_idtext
Id of the first booking made
bookingslist
Every booking made (several for a group or recurring booking)
Example output
{
  "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

Startstart_datetimedate and timeRequired
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.
Endend_datetimedate and timeRequired
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.
NotenotetextRequired
What the note says.
Applies tonote_modetext
Who the note is for.One of: all (Everyone), provider (One service provider), service (One service). Default: all.
Service providerservice_provider_idtext
The provider the note is for.Only when Applies to is One service provider.
Serviceservice_idtext
The service the note is for.Only when Applies to is One service.
Note typenote_type_idtext
The kind of note, which sets its colour. Leave empty for the default type.
Block timetime_blockedtrue/false
Turn on to stop clients booking during the note.Default: false.

Outputs

end_date_timetext
idtext
modetext
notetext
note_typeobject
note_type_idtext
providerobject
provider_idtext
serviceobject
service_idtext
start_date_timetext
time_blockedtrue/false
Example output
{
  "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

NamenametextRequired
The client's full name.
Emailemailtext
The client's email address.
Phonephonetext
The client's phone number, with country code.
Address line 1address1text
Street address. Only kept when the Client Login custom feature is on in SimplyBook.
Address line 2address2text
Second address line. Only kept when the Client Login custom feature is on in SimplyBook.
Citycitytext
City. Only kept when the Client Login custom feature is on in SimplyBook.
Postcodezip_codetext
Postcode or ZIP code. Only kept when the Client Login custom feature is on in SimplyBook.
Country codecountry_idtext
Two-letter country code, such as US or GB. Only kept when the Client Login custom feature is on in SimplyBook.
State idstate_idtext
SimplyBook's numeric id for the state or region. Only kept when the Client Login custom feature is on in SimplyBook.

Outputs

address1text
address2text
can_be_editedtrue/false
citytext
country_idtext
emailtext
email_promo_subscribedtrue/false
idtext
is_deletedtrue/false
nametext
phonetext
sms_promo_subscribedtrue/false
state_idtext
ziptext
Example output
{
  "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 notenote_idtextRequired
The note's id. Use 'List calendar notes' to find one, or chain it from 'Create calendar note'.

Outputs

deletedtrue/false
note_idtext
Example output
{
  "deleted": true,
  "note_id": "7"
}

Delete client

Delete a client from SimplyBook.

Inputs

Clientclient_idtextRequired
The client's id. Use 'List clients' to find one, or chain it from 'Create client'.

Outputs

client_idtext
deletedtrue/false
Example output
{
  "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

Serviceservice_idtextRequired
The service to book.
Service providerservice_provider_idtextRequired
The staff member or resource who provides the service.
DatedatedateRequired
The day to look at, in company time.
Placescountnumber
How many places to book in one go, for group services. Defaults to 1.From 1 to 1000. Default: 1.

Outputs

countnumber
datetext
slotslist
Free slots
Example output
{
  "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

Bookingbooking_idtextRequired
The booking's id. Use 'List bookings' to find one, or chain it from 'Create booking'.

Outputs

additional_fieldslist
can_be_canceledtrue/false
can_be_editedtrue/false
category_idtext
clientobject
client_idtext
codetext
commenttext
durationnumber
end_datetimetext
idtext
invoice_datetimetext
invoice_idtext
invoice_numbertext
invoice_payment_processortext
invoice_statustext
is_confirmedtrue/false
is_sequentialtrue/false
location_idtext
loglist
membership_idtext
providerobject
provider_idtext
resourceslist
serviceobject
service_idtext
start_datetimetext
statustext
ticket_codetext
ticket_is_usedtrue/false
ticket_validation_datetimetext
user_status_idtext
Example output
{
  "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 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

Bookingbooking_idtextRequired
The booking's id. Use 'List bookings' to find one, or chain it from 'Create booking'.

Outputs

booking_idtext
booking_linktext
cancel_linktext
reschedule_linktext
Example output
{
  "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

Clientclient_idtextRequired
The client's id. Use 'List clients' to find one, or chain it from 'Create client'.

Outputs

address1text
address2text
can_be_editedtrue/false
citytext
country_idtext
emailtext
email_promo_subscribedtrue/false
idtext
is_deletedtrue/false
nametext
phonetext
sms_promo_subscribedtrue/false
state_idtext
ziptext
Example output
{
  "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

Serviceservice_idtextRequired
The service to book.
Service providerservice_provider_idtextRequired
The staff member or resource who provides the service.
DatedatedateRequired
The day to look at, in company time.
Placescountnumber
How many places to book in one go, for group services. Defaults to 1.From 1 to 1000. Default: 1.

Outputs

datetext
YYYY-MM-DD
foundtrue/false
Whether a free slot was found
idtext
start_datetimetext
YYYY-MM-DD HH:MM:SS, ready for a booking's start time
timetext
HH:MM:SS, company time
Example output
{
  "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

bookingsnumber
Bookings this month
bookings_this_weeknumber
bookings_todaynumber
most_popular_providerobject
most_popular_provider_bookingsnumber
most_popular_serviceobject
most_popular_service_bookingsnumber
Example output
{
  "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

Statusstatustext
Only bookings with this status.One of: confirmed, confirmed_pending (Confirmed or pending), pending, canceled.
Upcoming onlyupcoming_onlytrue/false
Turn on to leave out bookings that have passed.Default: false.
Servicesservice_idslist
Only bookings for these services.
Service providersservice_provider_idslist
Only bookings with these providers.
Clientclient_idtext
Only this client's bookings. Use 'List clients' to find the id.
On datedatedate
Only bookings on this day.
From datedate_fromdate
Only bookings on or after this day.
To datedate_todate
Only bookings on or before this day.
Searchsearchtext
Only bookings whose code or client details contain this text.
Maximum resultsmax_resultsnumber
How many records to return, 1-500. Defaults to 50.From 1 to 500. Default: 50.

Outputs

bookingslist
Matching bookings
countnumber
Records returned
has_moretrue/false
Whether more match than were returned
total_countnumber
Records matching, in all
Example output
{
  "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 providersservice_provider_idslist
Only notes for these providers.
Servicesservice_idslist
Only notes for these services.
Note typesnote_type_idslist
Only notes of these types.
Searchsearchtext
Only notes containing this text.
From datedate_fromdate
Only notes on or after this day.
To datedate_todate
Only notes on or before this day.
Maximum resultsmax_resultsnumber
How many records to return, 1-500. Defaults to 50.From 1 to 500. Default: 50.

Outputs

countnumber
Records returned
has_moretrue/false
Whether more match than were returned
noteslist
Matching notes
total_countnumber
Records matching, in all
Example output
{
  "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

Searchsearchtext
Only return records matching this text.
Maximum resultsmax_resultsnumber
How many records to return, 1-500. Defaults to 50.From 1 to 500. Default: 50.

Outputs

clientslist
Matching clients
countnumber
Records returned
has_moretrue/false
Whether more match than were returned
total_countnumber
Records matching, in all
Example output
{
  "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

Searchsearchtext
Only return records matching this text.
Serviceservice_idtext
Only providers who offer this service.
Maximum resultsmax_resultsnumber
How many records to return, 1-500. Defaults to 50.From 1 to 500. Default: 50.

Outputs

countnumber
Records returned
has_moretrue/false
Whether more match than were returned
providerslist
Matching service providers
total_countnumber
Records matching, in all
Example output
{
  "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

Searchsearchtext
Only return records matching this text.
Maximum resultsmax_resultsnumber
How many records to return, 1-500. Defaults to 50.From 1 to 500. Default: 50.

Outputs

countnumber
Records returned
has_moretrue/false
Whether more match than were returned
serviceslist
Matching services
total_countnumber
Records matching, in all
Example output
{
  "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

Bookingbooking_idtextRequired
The booking's id. Use 'List bookings' to find one, or chain it from 'Create booking'.
CommentcommenttextRequired
The new comment. It replaces any comment already there.

Outputs

additional_fieldslist
can_be_canceledtrue/false
can_be_editedtrue/false
category_idtext
clientobject
client_idtext
codetext
commenttext
durationnumber
end_datetimetext
idtext
invoice_datetimetext
invoice_idtext
invoice_numbertext
invoice_payment_processortext
invoice_statustext
is_confirmedtrue/false
is_sequentialtrue/false
location_idtext
loglist
membership_idtext
providerobject
provider_idtext
resourceslist
serviceobject
service_idtext
start_datetimetext
statustext
ticket_codetext
ticket_is_usedtrue/false
ticket_validation_datetimetext
user_status_idtext
Example output
{
  "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

Bookingbooking_idtextRequired
The booking's id. Use 'List bookings' to find one, or chain it from 'Create booking'.
Serviceservice_idtext
A different service. Leave empty to keep it.
Service providerservice_provider_idtext
A different provider. Leave empty to keep them.
Clientclient_idtext
A different client. Leave empty to keep them.
Startstart_datetimedate 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.
Endend_datetimedate 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.
Placescountnumber
How many places to book in one go, for group services. Defaults to 1.From 1 to 1000. Default: 1.
Intake form answersadditional_fieldsobject
Answers to the booking form's extra fields, as field name and value, for example {"Reason for visit": "Check-up"}.

Outputs

batchobject
The group the bookings belong to, if any
bookingobject
The first booking made
booking_idtext
Id of the first booking made
bookingslist
Every booking made (several for a group or recurring booking)
Example output
{
  "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

Clientclient_idtextRequired
The client's id. Use 'List clients' to find one, or chain it from 'Create client'.
Namenametext
The client's full name. Leave empty to keep it.
Emailemailtext
The client's email address. Leave empty to keep it.
Phonephonetext
The client's phone number, with country code. Leave empty to keep it.
Address line 1address1text
Street address. Only kept when the Client Login custom feature is on in SimplyBook.
Address line 2address2text
Second address line. Only kept when the Client Login custom feature is on in SimplyBook.
Citycitytext
City. Only kept when the Client Login custom feature is on in SimplyBook.
Postcodezip_codetext
Postcode or ZIP code. Only kept when the Client Login custom feature is on in SimplyBook.
Country codecountry_idtext
Two-letter country code, such as US or GB. Only kept when the Client Login custom feature is on in SimplyBook.
State idstate_idtext
SimplyBook's numeric id for the state or region. Only kept when the Client Login custom feature is on in SimplyBook.

Outputs

address1text
address2text
can_be_editedtrue/false
citytext
country_idtext
emailtext
email_promo_subscribedtrue/false
idtext
is_deletedtrue/false
nametext
phonetext
sms_promo_subscribedtrue/false
state_idtext
ziptext
Example output
{
  "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
}

On this page