Update Share | Calendly | Developer Documentation

const url = 'https://api.calendly.com/shares/uuid';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "resource": {
    "uri": "https://api.calendly.com/shares/AAAAAAAAAAAAAAAA",
    "contact": "https://api.calendly.com/contacts/CCCCCCCCCCCCCCCC",
    "created_at": "2019-01-02T03:04:05.678123Z",
    "status": "active",
    "scheduling_links": [
      {
        "booking_url": "https://calendly.com/d/abcd-brv8/15-minute-meeting",
        "owner": "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA",
        "owner_type": "EventType"
      }
    ],
    "share_override": {
      "name": "15 Minute Meeting",
      "duration": 15,
      "duration_options": [
        1,
        13,
        15,
        720
      ],
      "period_type": "fixed",
      "start_date": "2019-01-02",
      "end_date": "2019-01-03",
      "max_booking_time": 300,
      "min_booking_time": 14400,
      "hide_location": true,
      "location_configurations": [
        {
          "location": "123 Abc St.",
          "additional_info": "Example additional info",
          "phone_number": "+1 888-888-8888",
          "position": 0,
          "kind": "physical"
        }
      ],
      "availability_rule": {
        "rules": [
          {
            "type": "wday",
            "intervals": [
              {
                "from": "07:00",
                "to": "11:00"
              }
            ],
            "wday": "friday"
          }
        ],
        "timezone": "America/New_York"
      }
    }
  }
}

Update a specified Share. Only unbooked, active single-use shares can be updated.

Omitted fields are unchanged. Setting a field to null restores the parent event type’s current value for that field only (for contact, null removes the contact). The parent event type is never modified.

Required scopes

shares:write

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Path parameters

uuidstringRequired

Request

At least one field is required

contactstring or nullOptionalformat: "uri"

Contact URI to associate with the share. Set to null to remove the contact

namestring or nullOptional<=55 characters

durationinteger or nullOptional1-720

duration_optionslist of integers or nullOptional

period_typeenum or nullOptional

Allowed values:

start_datestring or nullOptionalformat: "date"

Format: YYYY-MM-DD

end_datestring or nullOptionalformat: "date"

Format: YYYY-MM-DD

max_booking_timeinteger or nullOptional>=1

min_booking_timeinteger or nullOptional>=1

hide_locationboolean or nullOptional

location_configurationslist of objects or nullOptional

Replaces all existing location configurations

availability_ruleobject or nullOptional

Replaces the existing availability rule

Response

resourceobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error