[CAL-3743] no description of location in api reference

[GeneralKugelBlitz]

Create new booking api reference link: https://docs.cal.com/docs/enterprise-features/api/api-reference/bookings#create-a-new-booking

Issue Summary

there must be strings or JSON for each meeting provider, please provide us with the option strings in the api reference.

_CAL-3743

[dosubot[bot]]

To specify the location when creating a new booking through the Cal.com API, you'll need to adjust the location object in your booking request according to the meeting provider or location type. Here are examples for different scenarios:

1. Cal Video (Daily Video): Automatically set to Cal Video if no explicit location is provided.

"location": {
  "value": "BookingLocations.CalVideo"
}

2. Zoom Video: For Zoom meetings, specify Zoom Video as the location.

"location": {
  "value": "BookingLocations.ZoomVideo"
}

3. Physical Location (e.g., New York): Specify the address or name of the place for physical meetings.

"location": {
  "value": "New York"
}

4. Custom Meeting Provider: For custom providers or URLs, include the relevant details or URL.

"location": {
  "value": "http://custom-tool.example.com/meeting-1"
}

Ensure the location object matches the intended meeting provider or location type to provide clear and accurate meeting details for all participants. For more detailed examples and implementation, you can refer to the source code in the repository, specifically in the apps/api/v1/pages/api/bookings/_post.ts and packages/features/bookings/lib/handleNewBooking/test/fresh-booking.test.ts files.

Details

Sources

• apps/api/v1/pages/api/bookings/_post.ts
• packages/features/bookings/lib/handleNewBooking/test/fresh-booking.test.ts
• packages/platform/constants/api.ts
• packages/features/bookings/lib/getLocationOptionsForSelect.ts
• packages/features/bookings/lib/handleNewBooking.ts
• packages/features/bookings/lib/handleNewRecurringBooking.ts
• packages/trpc/server/routers/viewer/bookings/editLocation.handler.ts
• packages/trpc/server/routers/viewer/bookings/editLocation.schema.ts
• apps/ai/src/tools/updateBooking.ts

About Dosu This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

To continue the conversation, mention @dosu.

[PeerRich]

@alishaz-polymath

[Hamza525318]

I dint understand what has to be done Can someone please elaborate

[alishaz-polymath]

Detailed docs added, accessible here: https://cal.com/docs/enterprise-features/api/api-reference/v1/bookings#location-object