Events

Update Event

put/api/calendars/{calendar_public_id}/events/{public_id}

Request

  • Base URL: https://addcal.co
  • URL: https://addcal.co/api/calendars/{calendar_public_id}/events/{public_id}
  • Auth: none required

Query parameters

with_htmlboolean

Include HTML variants for calendar links in the response

Example:true

Request body

titlestring required

Must not be greater than 255 characters.

internal_namestring nullable

Must not be greater than 255 characters.

is_draftboolean nullable
descriptionstring nullable
locationstring nullable

Must not be greater than 255 characters.

is_all_dayboolean nullable
recurrence_rulestring nullable
series_titlestring nullable

Must not be greater than 255 characters.

has_rsvpboolean nullable
send_invite_updatesboolean nullable
date_startstring required

Must be a valid date.

date_endstring required

Must be a valid date. Must be a date after or equal to <code>date_start</code>.

timezonestring required

Must be a valid time zone, such as <code>Africa/Accra</code>.

busy_type'busy' | 'free' nullable
reminder_beforeinteger nullable

Must be at least 0.

short_linkstring nullable

Must match the regex /^[a-zA-Z0-9-]+$/. Must not be greater than 50 characters.

Example request

{
  "title": "wzutpboymqcdhnci",
  "internal_name": "d",
  "is_draft": true,
  "description": "Error ut sit omnis amet voluptatem dolore ducimus ratione.",
  "location": "f",
  "is_all_day": true,
  "series_title": "poqrszloaveloubrikvh",
  "date_start": "2026-08-28T03:20:12",
  "date_end": "2039-03-23",
  "timezone": "Asia/Bangkok",
  "busy_type": "busy",
  "reminder_before": 79,
  "short_link": "wmtcyxfbohadhiu"
}

Response

Example response

{
  "data": {
    "uid": "zxtmtrgpl1kv",
    "public_id": "evt_zxtmtrgpl1kv",
    "calendar_uid": "cal_hf1t8frn77k5",
    "short_link": null,
    "title": "Recusandae fuga similique natus earum.",
    "internal_name": null,
    "is_draft": false,
    "description": "<p>Non qui veniam eum omnis. Distinctio facilis et molestiae exercitationem minus eligendi tempore. Voluptas minus doloribus saepe provident facilis.</p>\n\n<p>Ad dolor ut et ullam reprehenderit et. Non eum iusto qui ipsa dolorem est. Cum et qui eligendi officia dolores.</p>",
    "location": null,
    "is_all_day": true,
    "has_rsvp": false,
    "has_calendar_invites": false,
    "rsvp_limit": null,
    "is_recurring": false,
    "recurrence_rule": null,
    "recurrence_text": null,
    "date_start": "2026-09-02T02:42:09+00:00",
    "date_end": "2026-09-02T06:42:09+00:00",
    "timezone": null,
    "busy_type": null,
    "reminder_before": null,
    "date_range_formatted": "Wed, Sep 2, 2026 (all day)",
    "public_url": "http://addcal.co/e/zxtmtrgpl1kv",
    "embed_url": "http://addcal.co/e/zxtmtrgpl1kv",
    "location_url": null,
    "image_url": null,
    "timezone_readable": null,
    "calendar": {
      "uid": "hf1t8frn77k5",
      "public_id": "cal_hf1t8frn77k5",
      "short_link": null,
      "name": "voluptatem sed neque",
      "internal_name": "molestias animi distinctio",
      "description": "<p>Non unde consectetur est velit. Recusandae tempore et tempora similique. Voluptate et totam voluptas voluptates.</p>",
      "timezone": "Africa/Libreville",
      "week_begins": 6,
      "public_url": "http://addcal.co/c/hf1t8frn77k5",
      "created_at": "2026-08-28T03:20:12.000000Z",
      "updated_at": "2026-08-28T03:20:12.000000Z"
    },
    "created_at": "2026-08-28T03:20:12.000000Z",
    "updated_at": "2026-08-28T03:20:12.000000Z"
  },
  "links": {
    "event_page": "http://addcal.co/e/zxtmtrgpl1kv",
    "auto": "https://addcal.co/e/zxtmtrgpl1kv/auto",
    "google": "https://addcal.co/e/zxtmtrgpl1kv/google",
    "apple": "https://addcal.co/e/zxtmtrgpl1kv/apple",
    "outlook": "https://addcal.co/e/zxtmtrgpl1kv/outlook",
    "outlook_web": "https://addcal.co/e/zxtmtrgpl1kv/outlook_web",
    "yahoo": "https://addcal.co/e/zxtmtrgpl1kv/yahoo",
    "office365": "https://addcal.co/e/zxtmtrgpl1kv/office365",
    "ics": "https://addcal.co/e/zxtmtrgpl1kv/ics"
  },
  "html": {
    "single-button": "Add to Calendar Button",
    "icon-buttons-single-row": "Buttons With Icons",
    "icons": "Text with Icons",
    "dot-sep": "Text (dot separated)",
    "space-sep": "Text (space separated)"
  }
}

Changes

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