SAsavvycal
Scheduling Links

Update a scheduling link

patch/v1/links/{link_id}

Request

Path parameters

link_idstring required

Request body

descriptionstring nullable

The short description visible on the scheduling link.

namestring
private_namestring nullable

The private name of the link (not visible to schedulers).

slugstring

The URL slug for the link. Letters, numbers, and dashes only, and unique within the scope.

type'recurring' | 'single'

Either recurring for Multi-Use links, or single for Single-Use links. Group links can't be single.

Example request

{
  "description": "Updated meeting description",
  "name": "Updated Meeting Name",
  "private_name": "Internal updated name",
  "type": "single"
}

Response

Success

default_durationinteger required

Default duration in minutes

descriptionstring

Link description, as HTML. Empty when the link has no description.

durationsinteger[] required

Durations in minutes

idstring required
incrementinteger required

Minutes between slot start times

namestring required

Public link name

private_namestring nullable

Private link name. null when the current user can't edit the link or the link has no private name.

slugstring required
state'active' | 'pending' | 'disabled' | 'archived' | 'deleted' required

Example response

{
  "default_duration": 30,
  "description": "<p>A brief meeting to discuss your needs</p>",
  "durations": [
    15,
    30,
    45
  ],
  "fields": [
    {
      "id": "field_123",
      "is_required": true,
      "label": "Company",
      "options": [],
      "type": "short_text"
    }
  ],
  "id": "link_01J5KC2G3MHPCECSQ6KM6FMDPC",
  "increment": 15,
  "name": "30 Minute Meeting",
  "private_name": "Quick sync with prospects",
  "scope": {
    "id": "scope_01J5KC4R7NHQFGT8V2WD9Y8H6X",
    "name": "Sales Team",
    "slug": "sales"
  },
  "slug": "30min",
  "state": "active"
}

Changes

No recorded changes to this operation across all 1 revision of this API.