/cal-bookings | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
cal_bookings_controller_2024_08_13_cancel_booking | Cancel a booking |
cal_bookings_controller_2024_08_13_confirm_booking | Confirm a booking |
cal_bookings_controller_2024_08_13_create_booking | Create a booking |
cal_bookings_controller_2024_08_13_decline_booking | Decline a booking |
cal_bookings_controller_2024_08_13_get_booking | Get a booking |
cal_bookings_controller_2024_08_13_get_bookings | Get all bookings |
cal_bookings_controller_2024_08_13_get_calendar_links | Get ‘Add to Calendar’ links for a booking |
cal_bookings_controller_2024_08_13_mark_no_show | Mark a booking absence |
cal_bookings_controller_2024_08_13_reassign_booking | Reassign a booking to auto-selected host |
cal_bookings_controller_2024_08_13_reassign_booking_to_user | Reassign a booking to a specific host |
cal_bookings_controller_2024_08_13_reschedule_booking | Reschedule a booking |
cal_bookings_controller_2024_08_13_cancel_booking
Cancel a booking Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version. |
bookingUid | string | Yes | — | Booking Uid |
body | object | Yes | — | Accepts different types of cancel booking input: Cancel Booking (Option 1 which is for normal or recurring bookings) or Cancel Seated Booking (Option 2 which is for seated bookings) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cal-api-version": {
"type": "string",
"description": "Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version."
},
"bookingUid": {
"type": "string",
"description": "Booking Uid"
},
"body": {
"description": "Accepts different types of cancel booking input: Cancel Booking (Option 1 which is for normal or recurring bookings) or Cancel Seated Booking (Option 2 which is for seated bookings)"
}
},
"required": [
"PCID",
"cal-api-version",
"bookingUid",
"body"
]
}
cal_bookings_controller_2024_08_13_confirm_booking
Confirm a booking Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version. |
bookingUid | string | Yes | — | Booking Uid |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cal-api-version": {
"type": "string",
"description": "Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version."
},
"bookingUid": {
"type": "string",
"description": "Booking Uid"
}
},
"required": [
"PCID",
"cal-api-version",
"bookingUid"
]
}
cal_bookings_controller_2024_08_13_create_booking
Create a booking Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version. |
body | object | Yes | — | Accepts different types of booking input: Create Booking (Option 1), Create Instant Booking (Option 2), or Create Recurring Booking (Option 3) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cal-api-version": {
"type": "string",
"description": "Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version."
},
"body": {
"description": "Accepts different types of booking input: Create Booking (Option 1), Create Instant Booking (Option 2), or Create Recurring Booking (Option 3)"
}
},
"required": [
"PCID",
"cal-api-version",
"body"
]
}
cal_bookings_controller_2024_08_13_decline_booking
Decline a booking Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version. |
bookingUid | string | Yes | — | Booking Uid |
reason | string | No | — | Reason for declining a booking that requires a confirmation |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cal-api-version": {
"type": "string",
"description": "Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version."
},
"bookingUid": {
"type": "string",
"description": "Booking Uid"
},
"reason": {
"type": "string",
"description": "Reason for declining a booking that requires a confirmation"
}
},
"required": [
"PCID",
"cal-api-version",
"bookingUid"
]
}
cal_bookings_controller_2024_08_13_get_booking
Get a booking Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version. |
bookingUid | string | Yes | — | Booking Uid |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cal-api-version": {
"type": "string",
"description": "Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version."
},
"bookingUid": {
"type": "string",
"description": "Booking Uid"
}
},
"required": [
"PCID",
"cal-api-version",
"bookingUid"
]
}
cal_bookings_controller_2024_08_13_get_bookings
Get all bookings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version. |
status | string[] | No | — | Filter bookings by status. If you want to filter by multiple statuses, separate them with a comma. |
attendeeEmail | string | No | — | Filter bookings by the attendee’s email address. |
attendeeName | string | No | — | Filter bookings by the attendee’s name. |
bookingUid | string | No | — | Filter bookings by the booking Uid. |
eventTypeIds | string | No | — | Filter bookings by event type ids belonging to the user. Event type ids must be separated by a comma. |
eventTypeId | string | No | — | Filter bookings by event type id belonging to the user. |
teamsIds | string | No | — | Filter bookings by team ids that user is part of. Team ids must be separated by a comma. |
teamId | string | No | — | Filter bookings by team id that user is part of |
afterStart | string | No | — | Filter bookings with start after this date string. |
beforeEnd | string | No | — | Filter bookings with end before this date string. |
afterCreatedAt | string | No | — | Filter bookings that have been created after this date string. |
beforeCreatedAt | string | No | — | Filter bookings that have been created before this date string. |
afterUpdatedAt | string | No | — | Filter bookings that have been updated after this date string. |
beforeUpdatedAt | string | No | — | Filter bookings that have been updated before this date string. |
sortStart | string | No | — | Sort results by their start time in ascending or descending order. |
sortEnd | string | No | — | Sort results by their end time in ascending or descending order. |
sortCreated | string | No | — | Sort results by their creation time (when booking was made) in ascending or descending order. |
sortUpdatedAt | string | No | — | Sort results by their updated time (for example when booking status changes) in ascending or descending order. |
take | number | No | — | The number of items to return |
skip | number | No | — | The number of items to skip |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cal-api-version": {
"type": "string",
"description": "Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version."
},
"status": {
"type": "array",
"items": {
"type": "string",
"enum": [
"upcoming",
"recurring",
"past",
"cancelled",
"unconfirmed"
]
},
"description": "Filter bookings by status. If you want to filter by multiple statuses, separate them with a comma."
},
"attendeeEmail": {
"type": "string",
"description": "Filter bookings by the attendee's email address."
},
"attendeeName": {
"type": "string",
"description": "Filter bookings by the attendee's name."
},
"bookingUid": {
"type": "string",
"description": "Filter bookings by the booking Uid."
},
"eventTypeIds": {
"type": "string",
"description": "Filter bookings by event type ids belonging to the user. Event type ids must be separated by a comma."
},
"eventTypeId": {
"type": "string",
"description": "Filter bookings by event type id belonging to the user."
},
"teamsIds": {
"type": "string",
"description": "Filter bookings by team ids that user is part of. Team ids must be separated by a comma."
},
"teamId": {
"type": "string",
"description": "Filter bookings by team id that user is part of"
},
"afterStart": {
"type": "string",
"description": "Filter bookings with start after this date string."
},
"beforeEnd": {
"type": "string",
"description": "Filter bookings with end before this date string."
},
"afterCreatedAt": {
"type": "string",
"description": "Filter bookings that have been created after this date string."
},
"beforeCreatedAt": {
"type": "string",
"description": "Filter bookings that have been created before this date string."
},
"afterUpdatedAt": {
"type": "string",
"description": "Filter bookings that have been updated after this date string."
},
"beforeUpdatedAt": {
"type": "string",
"description": "Filter bookings that have been updated before this date string."
},
"sortStart": {
"type": "string",
"description": "Sort results by their start time in ascending or descending order.",
"enum": [
"asc",
"desc"
]
},
"sortEnd": {
"type": "string",
"description": "Sort results by their end time in ascending or descending order.",
"enum": [
"asc",
"desc"
]
},
"sortCreated": {
"type": "string",
"description": "Sort results by their creation time (when booking was made) in ascending or descending order.",
"enum": [
"asc",
"desc"
]
},
"sortUpdatedAt": {
"type": "string",
"description": "Sort results by their updated time (for example when booking status changes) in ascending or descending order.",
"enum": [
"asc",
"desc"
]
},
"take": {
"type": "number",
"description": "The number of items to return"
},
"skip": {
"type": "number",
"description": "The number of items to skip"
}
},
"required": [
"PCID",
"cal-api-version"
]
}
cal_bookings_controller_2024_08_13_get_calendar_links
Get ‘Add to Calendar’ links for a booking Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version. |
bookingUid | string | Yes | — | Booking Uid |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cal-api-version": {
"type": "string",
"description": "Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version."
},
"bookingUid": {
"type": "string",
"description": "Booking Uid"
}
},
"required": [
"PCID",
"cal-api-version",
"bookingUid"
]
}
cal_bookings_controller_2024_08_13_mark_no_show
Mark a booking absence Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version. |
bookingUid | string | Yes | — | Booking Uid |
attendees | object[] | No | — | The attendees value |
host | boolean | No | — | Whether the host was absent |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cal-api-version": {
"type": "string",
"description": "Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version."
},
"bookingUid": {
"type": "string",
"description": "Booking Uid"
},
"attendees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email value"
},
"absent": {
"type": "boolean",
"description": "The absent value"
}
},
"required": [
"email",
"absent"
]
},
"description": "The attendees value"
},
"host": {
"type": "boolean",
"description": "Whether the host was absent"
}
},
"required": [
"PCID",
"cal-api-version",
"bookingUid"
]
}
cal_bookings_controller_2024_08_13_reassign_booking
Reassign a booking to auto-selected host Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version. |
bookingUid | string | Yes | — | Booking Uid |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cal-api-version": {
"type": "string",
"description": "Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version."
},
"bookingUid": {
"type": "string",
"description": "Booking Uid"
}
},
"required": [
"PCID",
"cal-api-version",
"bookingUid"
]
}
cal_bookings_controller_2024_08_13_reassign_booking_to_user
Reassign a booking to a specific host Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version. |
bookingUid | string | Yes | — | Booking Uid |
userId | number | Yes | — | User Id |
reason | string | No | — | Reason for reassigning the booking |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cal-api-version": {
"type": "string",
"description": "Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version."
},
"bookingUid": {
"type": "string",
"description": "Booking Uid"
},
"userId": {
"type": "number",
"description": "User Id"
},
"reason": {
"type": "string",
"description": "Reason for reassigning the booking"
}
},
"required": [
"PCID",
"cal-api-version",
"bookingUid",
"userId"
]
}
cal_bookings_controller_2024_08_13_reschedule_booking
Reschedule a booking Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version. |
bookingUid | string | Yes | — | Booking Uid |
body | object | Yes | — | Accepts different types of reschedule booking input: Reschedule Booking (Option 1) or Reschedule Seated Booking (Option 2). If you’re rescheduling a seated booking as org admin of booking host, pass booking input for Reschedule Booking (Option 1) along with your access token in the request header. If you are rescheduling a seated booking for an event type with ‘show attendees’ disabled, then to retrieve attendees in the response either set ‘show attendees’ to true on event type level or you have to provide an authentication method of event type owner, host, team admin or owner or org admin or owner. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cal-api-version": {
"type": "string",
"description": "Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version."
},
"bookingUid": {
"type": "string",
"description": "Booking Uid"
},
"body": {
"description": "Accepts different types of reschedule booking input: Reschedule Booking (Option 1) or Reschedule Seated Booking (Option 2). If you're rescheduling a seated booking as org admin of booking host, pass booking input for Reschedule Booking (Option 1) along with your access token in the request header. If you are rescheduling a seated booking for an event type with 'show attendees' disabled, then to retrieve attendees in the response either set 'show attendees' to true on event type level or you have to provide an authentication method of event type owner, host, team admin or owner or org admin or owner."
}
},
"required": [
"PCID",
"cal-api-version",
"bookingUid",
"body"
]
}