You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix spelling, inconsistencies, and bugs across API documentation
Correct factual errors (wrong HTTP method for user creation, wrong noun
in event update, inverted ignore_capacity logic, singular webhook paths),
fix spelling mistakes and grammar across endpoints/guides/changelog,
standardize DateTime to Datetime, remove trailing slashes from listing
URLs, update curl examples to use Bearer auth, add missing attributes
to JSON examples and attribute tables, add date-handling examples, and
add update endpoint for providers.
Co-Authored-By: Claude <noreply@anthropic.com>
@@ -77,11 +77,11 @@ See query parameters for filtering the output beyond the default outputs.
77
77
78
78
`GET /bookings/recent` will return all active bookings ordered based on updated_at.
79
79
80
-
`GET /bookings/upcoming` will return all active bookings from and including `{date}`.
80
+
`GET /bookings/upcoming` will return all future active bookings.
81
81
82
82
`GET /bookings/unconfirmed` will return only unconfirmed bookings.
83
83
84
-
`GET /bookings/all` will return all bookings of all states (including `declined`, `cancelled`, `deleted`, and `verification_expired`). This is a useful output for syncronisation when you need to keep a track of deleted bookings.
84
+
`GET /bookings/all` will return all bookings of all states (including `declined`, `cancelled`, `deleted`, and `verification_expired`). This is a useful output for synchronisation when you need to keep a track of deleted bookings.
85
85
86
86
`GET /bookings/visible` will return all active bookings as well as those declined or cancelled. This is the preferred output if you want to provide a list of all bookings for visual presentation.
87
87
@@ -120,9 +120,9 @@ Response
120
120
<tr><td>resource_id</td><td>Integer or array of integers</td><td></td></tr>
121
121
<tr><td>person_id</td><td>Integer or array of integers</td><td></td></tr>
<tr><td>confirm</td><td>Boolean</td><td>If set to false then the 'initiate verification' event is executed. If verification is required the state will be set to `awaiting_verification`. If no verification is required then the state will be set to `awaiting_confirmation` or `confirmed`.</td></tr>
174
-
<tr><td>ignore_capacity</td><td>Boolean</td><td>Will force save the booking even though other bookings exists within the same time on the specified resource_id (double booking). Not applicable when `public_booking` is set to false (no double bookings allowed). Default: false.</td></tr>
174
+
<tr><td>ignore_capacity</td><td>Boolean</td><td>Will force save the booking even though other bookings exists within the same time on the specified resource_id (double booking). Not applicable when `public_booking` is set to true (no double bookings allowed). Default: false.</td></tr>
175
175
<tr><td>add_reminder_sms</td><td>Boolean</td><td>Automatically adds `reminder_at` based on setting from account attribute `sms_reminder_time`. Default: at 12PM the day before the appointment.</td></tr>
176
176
<tr><td>add_messages</td><td>Boolean</td><td>Automatically generate messages based on message templates. (NOTE: Beta functionality available by invitation.)</td></tr>
177
177
<tr><td>verification_send_email</td><td>Boolean</td><td>Send out verification email. Only applicable when `confirm` is set to false.</td></tr>
Copy file name to clipboardExpand all lines: _endpoints/events.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Events
3
3
nav_order: 5
4
4
---
5
5
6
-
Unlike appointments made through a normal service events starts and ends at a specific time. An event is connected to a resource and a service. It could be either a one-off event (e.q. a concert) or something that occurs multiple times (e.q. spinning class). Event bookings have a strong relation to the event. That means that it is not possible to modify details such as `{booked_from}`, `{booked_to}`, `{resource_id}` and `{service_id}` for the `{booking}`. To make such changes it must be done to the event. All bookings connected to the event will then automatically me modified.
6
+
Unlike appointments made through a normal service events starts and ends at a specific time. An event is connected to a resource and a service. It could be either a one-off event (e.g. a concert) or something that occurs multiple times (e.g. spinning class). Event bookings have a strong relation to the event. That means that it is not possible to modify details such as `{booked_from}`, `{booked_to}`, `{resource_id}` and `{service_id}` for the `{booking}`. To make such changes it must be done to the event. All bookings connected to the event will then automatically be modified.
7
7
8
8
While events are connected to a resource bookings or capacity of an event are not restricted by the opening hours or availability of a resource.
9
9
@@ -21,12 +21,13 @@ While events are connected to a resource bookings or capacity of an event are no
<tr><td>start</td><td>DateTime</td><td>starts_at after param</td></tr>
61
-
<tr><td>end</td><td>DateTime</td><td>ends_at before param</td></tr>
62
-
<tr><td>since</td><td>DateTime</td><td>updated_at after param</td></tr>
61
+
<tr><td>start</td><td>Datetime</td><td>starts_at after param</td></tr>
62
+
<tr><td>end</td><td>Datetime</td><td>ends_at before param</td></tr>
63
+
<tr><td>since</td><td>Datetime</td><td>updated_at after param</td></tr>
63
64
</table>
64
65
65
66
## Get event
@@ -72,7 +73,7 @@ Response
72
73
73
74
## Add recurring/multiple events
74
75
75
-
`POST /events/recurring` will create a multiple events.
76
+
`POST /events/recurring` will create multiple events.
76
77
77
78
The recurrence format follows the [iCalendar specification](https://tools.ietf.org/html/rfc5545){:target="_blank"}. The attributes for recurrence are: `RRULE`, `RDATE`, `EXDATE`. For an introduction and examples of these parameters see [this section from the iCalendar specification](http://www.kanzaki.com/docs/ical/rrule.html){:target="_blank"}.
78
79
@@ -103,11 +104,11 @@ You should always specify COUNT or UNTIL with RRULE. The max number of occurrenc
103
104
104
105
## Update event
105
106
106
-
`PUT /events/{event_id}` will update existing service with id `{event_id}`.
107
+
`PUT /events/{event_id}` will update existing event with id `{event_id}`.
107
108
108
109
## Delete event
109
110
110
-
`DELETE /events/{event_id}` will delete existing event with id `{event_id}`. Deleting a event will set it to active=false and will not be returned in any listings.
111
+
`DELETE /events/{event_id}` will delete existing event with id `{event_id}`. Deleting an event will set it to active=false and will not be returned in any listings.
Copy file name to clipboardExpand all lines: _endpoints/people.md
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: People
3
3
nav_order: 3
4
4
---
5
5
6
-
The primary key for a person is `id`. However the following fields are unique: `email`, `phonenumber`, `national_id_no` and `provider`+`uid`. There are no specific requirements for input but a person needs to have either name, email, national id number or phone number.
6
+
The primary key for a person is `id`. However the following fields are unique: `email`, `phone_number`, `national_id_no` and `provider`+`uid`. There are no specific requirements for input but a person needs to have either name, email, national id number or phone number.
7
7
8
8
It is possible to give a person ability to book on behalf of other people. This is linked through the `parent_id` attribute.
Copy file name to clipboardExpand all lines: _endpoints/resource-exception-dates.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ nav_order: 7
5
5
6
6
Opening hours for a resource is what is used to generate available slots for a service.
7
7
It is based on the default opening hours on the resource unless anything else is specified by a resource exception date.
8
-
So ignore the poorly naming of the feature and treat it as opening hours on dates.
8
+
So ignore the poor naming of the feature and treat it as opening hours on dates.
9
9
If a resource should be closed for a week then you would add resource exception dates.
10
10
If a resource should have opening hours 08:00 to 14:00 on January 5th 2016 instead of the default opening hours for that weekday which could be 09:00 to 15:00, then add it as a resource exception date.
11
11
See [resource opening hours](/endpoints/resources/#default-opening-hours) for how to specify.
0 commit comments