Update a private link for a team event type

If accessed using an OAuth access token, the TEAM_EVENT_TYPE_WRITE scope is required.

PATCH /v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/private-links/{linkId}

Update a private link for a team event type

cURL

curl --request PATCH \
  --url https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/private-links/{linkId} \
  --header 'cal-api-version: <cal-api-version>'

import requests

url = "https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/private-links/{linkId}"

headers = {"cal-api-version": "<cal-api-version>"}

response = requests.patch(url, headers=headers)

print(response.text)

const options = {method: 'PATCH', headers: {'cal-api-version': '<cal-api-version>'}};

fetch('https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/private-links/{linkId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/private-links/{linkId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_HTTPHEADER => [
    "cal-api-version: <cal-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/private-links/{linkId}"

	req, _ := http.NewRequest("PATCH", url, nil)

	req.Header.Add("cal-api-version", "<cal-api-version>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/private-links/{linkId}")
  .header("cal-api-version", "<cal-api-version>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/private-links/{linkId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["cal-api-version"] = '<cal-api-version>'

response = http.request(request)
puts response.read_body

200

{
  "status": "success",
  "data": {
    "linkId": "abc123def456",
    "eventTypeId": 123,
    "isExpired": false,
    "bookingUrl": "https://cal.com/d/abc123def456",
    "expiresAt": "2025-12-31T23:59:59.000Z"
  }
}

Headers

cal-api-version · string · default: 2024-09-04 · required

Must be set to 2024-09-04. Returns the full booking URL including org slug and event slug.

Example:

"2024-09-04"

Authorization · string

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

x-cal-secret-key · string

For platform customers - OAuth client secret key

x-cal-client-id · string

For platform customers - OAuth client ID

Path Parameters

teamId · number · required

eventTypeId · number · required

linkId · string · required

orgId · number · required

Response

200 - application/json

status · string · required

Response status

Example:

"success"

data · object · required

Updated private link data (either time-based or usage-based)

Option 1

Option 2

Show child attributes