Skip to main content
POST
Create an add-on service
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Path Parameters

meeting_sid
string
required

The unique identifier (SID) of the scheduling link you want to use. You can get sid in different ways. Visit the scheduling link page and then click on "Settings" > "Show SID". That will give you sid. You can also get this from the response of the List scheduling links endpoint, where it appears as the sid property for each scheduling link in the response.

Example:

"vj5pgkh"

Body

application/json
name
string
required

Name of the add-on service shown to the person booking.

Example:

"Sauna"

description
string

Description of the add-on service.

Example:

"20 minutes in the sauna"

duration
integer
default:0

Minutes the add-on service adds to the booking. Must be 0 for group meetings, because everyone in a group meeting shares the same slot.

Required range: 0 <= x <= 1440
Example:

30

price
number | null

Price in the major unit of the scheduling link's currency, for example 25.5. The currency and payment provider are taken from the scheduling link's fee, so a positive price needs payments to be enabled on the scheduling link. Pass 0 or null to make the add-on service free. A price above the payment provider's maximum for the currency returns a 422 error.

Example:

25.5

position
integer

Position to insert the add-on service at, from 1 to the current number of add-on services plus one. The add-on services at and after that position move down by one. Defaults to the end of the list.

Example:

1

Response

Created - Add-on service created successfully

add_on_service
object