Skip to main content
PUT
Update Booking

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id
integer<int64>
required

The ID of the booking to update

check_clashes
boolean

Report any clashes with new resources supplied, or existing resources on the booking

notify_user_resources
boolean
default:true

Specifies if user resources (resources with a contact attached) should be sent an email notification about the updated booking

repeat_update_scope
enum<string>

If updating a repeat booking, specifies if the changes should be replicated to all, future or just the single booking. Default is single

Available options:
single,
future,
all

Body

application/json

Booking object that needs to be updated

Standard booking model that returns most properties by default

id
integer

Booking ID

Example:

1

name
string

Booking Name

Example:

"Test Booking"

start
integer

Unix Timestamp of the booking start. Alternatively use start_date_time_iso which automatically calculates the unix timestamp.

Example:

1547501100

end
integer

Unix timestamp of the booking end. Alternatively use end_date_time_iso which automatically calculates the unix timestamp.

Example:

1547538900

start_date_time_iso
string

ISO-8601 formatted result of the booking start

Example:

"2022-02-22T09:00:00+11:00"

end_date_time_iso
string

ISO-8601 formatted result of the booking end

Example:

"2022-02-22T17:00:00+11:00"

all_day
boolean

Is the booking all day

Example:

"false"

notes
string

Additional booking information

Example:

"Additional note"

repeat_master
boolean

Is this booking designated as the master booking linked to repeats

Example:

"true"

repeat_master_id
integer

If this booking is a repeat, this is the id of the master booking

Example:

"0"

repeat_rule
string

Specifically formatted rule for the repeat logic

Example:

"FREQ=daily;INTERVAL=2;REPENDTYPE=date;UNTIL=20220228T130000;"

resources
Resource Booking Model · object[]
project
Project Summary Model · object[]
client
Client model · object[]

The client (either person or organization) attached to this booking

status
Status Summary Model · object[]
billable_items
Billable Items on booking model · object[]
custom_fields
Custom Field Module Value · object[]

Response

Successful Operation

success
object