Events

Create Event

post/api/calendars/{calendar_public_id}/events

Request

  • Base URL: https://addcal.co
  • URL: https://addcal.co/api/calendars/{calendar_public_id}/events
  • 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
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": "qfklgofxpwqrzoyyso",
  "internal_name": "qnejarzznkmdbpdzsvgawqge",
  "is_draft": true,
  "description": "Sed quia assumenda hic sed.",
  "location": "yhvzbvbwzdunsfdynvfngckud",
  "series_title": "gymxabwgycqcqerkqam",
  "has_rsvp": true,
  "date_start": "2026-08-28T03:20:12",
  "date_end": "2038-06-19",
  "timezone": "Asia/Kuala_Lumpur",
  "busy_type": "free",
  "reminder_before": 38,
  "short_link": "bdqcwkcthudpkbrdnnzhbhspl"
}

Response

Example response

{
  "data": {
    "uid": "7v4ykqe3kiwl",
    "public_id": "evt_7v4ykqe3kiwl",
    "calendar_uid": "cal_fo3p4eu2bv2c",
    "short_link": null,
    "title": "Et rerum sint sit tempora sapiente veritatis.",
    "internal_name": null,
    "is_draft": false,
    "description": "<p>Eum officia harum quaerat voluptate laborum omnis deleniti. Culpa qui et nobis quae non ut. Pariatur esse deleniti doloribus non eos beatae dolor laudantium.</p>\n\n<p>Corrupti et fuga nihil. Vel itaque et et. Quia dolorem repudiandae saepe eveniet. Et enim et voluptatum quis expedita aspernatur adipisci.</p>",
    "location": null,
    "is_all_day": false,
    "has_rsvp": false,
    "has_calendar_invites": false,
    "rsvp_limit": null,
    "is_recurring": false,
    "recurrence_rule": null,
    "recurrence_text": null,
    "date_start": "2026-07-31T11:48:47+08:00",
    "date_end": "2026-07-31T12:48:47+08:00",
    "timezone": "Asia/Shanghai",
    "busy_type": null,
    "reminder_before": null,
    "date_range_formatted": "Fri, Jul 31, 2026 11:48 AM - 12:48 PM",
    "public_url": "http://addcal.co/e/7v4ykqe3kiwl",
    "embed_url": "http://addcal.co/e/7v4ykqe3kiwl",
    "location_url": null,
    "image_url": null,
    "timezone_readable": "CST / GMT+08:00",
    "calendar": {
      "uid": "fo3p4eu2bv2c",
      "public_id": "cal_fo3p4eu2bv2c",
      "short_link": null,
      "name": "et dolor commodi",
      "internal_name": null,
      "description": "<p>Quos corporis minima non impedit et. Architecto et velit natus. Sed id necessitatibus omnis atque ipsa rerum. Unde quo labore eos sed.</p>",
      "timezone": "America/St_Lucia",
      "week_begins": 1,
      "public_url": "http://addcal.co/c/fo3p4eu2bv2c",
      "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/7v4ykqe3kiwl",
    "auto": "https://addcal.co/e/7v4ykqe3kiwl/auto",
    "google": "https://addcal.co/e/7v4ykqe3kiwl/google",
    "apple": "https://addcal.co/e/7v4ykqe3kiwl/apple",
    "outlook": "https://addcal.co/e/7v4ykqe3kiwl/outlook",
    "outlook_web": "https://addcal.co/e/7v4ykqe3kiwl/outlook_web",
    "yahoo": "https://addcal.co/e/7v4ykqe3kiwl/yahoo",
    "office365": "https://addcal.co/e/7v4ykqe3kiwl/office365",
    "ics": "https://addcal.co/e/7v4ykqe3kiwl/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.