Skip to content

Update a booking

Request

Updates the booking identified by the id in the path. If the request body also contains an id, it must match the path id; otherwise the request is rejected with 400 (parameter_invalid, "Invalid id").

Video meeting (location):

  • Keep the existing meeting unchanged: send the booking's existing location back as it was returned (type, and video_type with its id, link and type).
  • Remove the meeting: send an empty object, "location": {}.
  • Generate a new meeting: send location with type: ["videoType"] and video_type: [{ "type": "google-meet" }]. Providing the provider type is enough, and the link is generated.
Security
BearerAuth
Path
idstringrequired
Example:bk_123456
Bodyapplication/jsonrequired
idstring

Booking id. Optional on update; when sent it must equal the {id} path parameter, otherwise the request is rejected with 400 (parameter_invalid, "Invalid id").

Example:"bk_123456"
typestringrequired

What you are booking. It must match the type of the service in service_id:

  • APPOINTMENT: a one-to-one booking of a service (a service whose type is SERVICE).
  • SESSION: a place in a group class (a service whose type is CLASS). A session holds from 0 up to 50 customers, and never more than the number of seats the class offers (the max_seats of its service).

If it does not match, the request is rejected with 400 parameter_invalid. The type of an existing booking can't be changed on update.

Enum:"APPOINTMENT""SESSION"
Example:"APPOINTMENT"
account_idstringrequired

Setmore account id that owns this booking.

Example:"acc_123456"
provider_idstringrequired

Id of the staff member assigned to this booking.

Example:"provider_123456"
consumer_idsArray of stringsrequired

Ids of the customers attending this booking.

Any other number of customers is rejected with 400 out_of_range.

Example:
[ "cust_123456" ]
service_idstringrequired

Id of the service or class being booked. Its type must match the booking type (SERVICE for an APPOINTMENT, CLASS for a SESSION).

Example:"svc_123456"
start_atstring, (date-time)required

Start date/time, an RFC 3339 date-time with an offset: Z for UTC or a numeric offset such as +08:00, in whole seconds. For example, 2026-11-19T08:30:00+08:00 and 2026-11-19T00:30:00Z are the same moment. It is returned in UTC.

Example:"2026-11-19T08:30:00+08:00"
end_atstring, (date-time)required

End date/time, an RFC 3339 date-time with an offset: Z for UTC or a numeric offset such as +08:00, in whole seconds. For example, 2026-11-19T09:00:00+08:00 and 2026-11-19T01:00:00Z are the same moment. It is returned in UTC.

Example:"2026-11-19T09:00:00+08:00"
costnumber, (double), [ 0 .. 1000000 ]

Cost of the appointment. Defaults to 0 when not provided.

Default:0
Example:50
titlestring, <= 255 characters

Title of the booking. Defaults to an empty string when not provided.

Default:""
Example:"Consultation"
notesstring, <= 1500 characters

Notes about the booking. Defaults to an empty string when not provided.

Default:""
Example:"Customer requested a reminder call the day before."
labelstring, <= 100 characters

Free-text label for the booking, e.g. a status or reminder tag such as RUNNING_LATE or NO_SHOW. Defaults to an empty string when not provided.

Default:""
Example:"RUNNING_LATE"
locationobject(BookingLocationUpdateRequest)

Video meeting for the booking. See the table for what to send to keep, remove or generate a meeting.

sourcestring, <= 100 characters

Origin of the booking (e.g. integration name).

Example:"booking_page"
meta_dataobject, <= 5 properties

Unstructured key/value passthrough data, with up to 5 entries and each value up to 1500 characters.

Default:{}
Example:
{ "referred_by": "google_ads" }
curl -i -X PUT \
  https://developer.setmore.com/api/v2/bookings/bk_123456 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "bk_123456",
    "type": "APPOINTMENT",
    "account_id": "acc_123456",
    "provider_id": "provider_123456",
    "consumer_ids": [
      "cust_123456"
    ],
    "service_id": "svc_123456",
    "start_at": "2026-11-19T08:30:00+08:00",
    "end_at": "2026-11-19T09:00:00+08:00",
    "cost": 50,
    "title": "Consultation",
    "notes": "Customer requested a reminder call the day before.",
    "label": "RUNNING_LATE",
    "location": {
      "type": [
        "videoType"
      ],
      "video_type": [
        {
          "type": "google-meet",
          "id": "vid_123456",
          "link": "https://meet.google.com/abc-defg-hij"
        }
      ]
    },
    "source": "booking_page",
    "meta_data": {
      "referred_by": "google_ads"
    }
  }'

Responses

Booking updated.

Bodyapplication/json
dataobject(Booking)

A booking, as returned in API responses.

Response
{ "data": { "id": "bk_123456", "type": "APPOINTMENT", "calendar_id": "cal_123456", "account_id": "acc_123456", "provider_id": "provider_123456", "consumer_ids": [ … ], "service_id": "svc_123456", "start_at": "2026-01-20T09:00:00Z", "end_at": "2026-01-20T10:00:00Z", "booking_id": "ext_bk_654321", "cost": 50, "title": "Consultation", "notes": "Customer requested a reminder call the day before.", "status": "CONFIRMED", "label": "RUNNING_LATE", "location": { … }, "created_at": "2026-01-15T12:00:00Z", "source": "booking_page", "meta_data": { … } } }