Create Event

post/api/events

Request

  • Base URL: https://addcal.co
  • URL: https://addcal.co/api/events
  • Auth: none required

Query parameters

with_htmlboolean

Include HTML variants for calendar links in the response

Example:true

Request body

titlestring required

The title of the event. Must not be greater than 255 characters.

descriptionstring nullable

A detailed description of the event.

locationstring nullable

The location where the event will take place. Must not be greater than 255 characters.

is_all_dayboolean

Whether this is an all-day event.

is_virtualboolean nullable

Whether this is a virtual/online event.

organiser_namestring nullable

The name of the event organiser. Must not be greater than 255 characters.

organiser_emailstring nullable

The email address of the event organiser. Must be a valid email address. Must not be greater than 191 characters.

recurrence_rulestring nullable

iCalendar RRULE string for recurring events (e.g. FREQ=DAILY;INTERVAL=1;COUNT=3).

series_titlestring nullable

Title for the recurring event series. Defaults to the event title if not provided. Must not be greater than 255 characters.

has_rsvpboolean nullable

Whether this event allows RSVP responses.

date_startstring required

The start date and time of the event. Must be a valid date.

date_endstring required

The end date and time of the event. If not provided, defaults to 1 hour after start time. Must be a valid date. Must be a date after or equal to <code>date_start</code>.

timezonestring nullable

The timezone for the event. Defaults to calendar timezone if not provided. Must be a valid time zone, such as <code>Africa/Accra</code>.

busy_type'busy' | 'free' nullable

Whether the event shows as busy or free on calendars. Options: busy, or free, calendar default when null.

reminder_beforeinteger nullable

Minutes before the event to send a notification. Common values: 0, 5, 10, 15, 30, 60, 120, 1440 (1 day), etc. Must be at least 0.

short_linkstring nullable

Custom short link for the event. Only available for subscribers. Must match the regex /^[a-zA-Z0-9-]+$/. Must not be greater than 50 characters.

team_uidstring nullable

The unique identifier of the team to create the event for. Defaults to current team or first available team.

calendar_uidstring nullable

The unique identifier of an existing calendar to create the event in.

calendar_namestring nullable

Name of the calendar to create or use. Cannot be used with calendar_uid. Must not be greater than 255 characters.

Example request

{
  "title": "Team Meeting",
  "description": "Monthly team sync to discuss project progress and upcoming milestones.",
  "location": "Conference Room A or https://zoom.us/j/123456789",
  "organiser_name": "Jane Smith",
  "organiser_email": "jane@example.com",
  "recurrence_rule": "FREQ=WEEKLY;BYDAY=MO;COUNT=10",
  "series_title": "Weekly Team Meeting",
  "date_start": "2024-03-25 14:00:00",
  "date_end": "2024-03-25 15:00:00",
  "timezone": "America/New_York",
  "busy_type": "busy",
  "reminder_before": 30,
  "short_link": "my-event",
  "team_uid": "team_abc123",
  "calendar_uid": "cal_xyz789",
  "calendar_name": "Team Meetings"
}

Response

Example response

{
  "data": {
    "uid": "rkpp3x41r8ih",
    "public_id": "evt_rkpp3x41r8ih",
    "calendar_uid": "cal_m9aokdxfmnhh",
    "short_link": null,
    "title": "Ut sequi magni vel dolorem id deleniti quia.",
    "internal_name": null,
    "is_draft": false,
    "description": "<p>Omnis beatae accusantium et quasi et. Quo aliquam quaerat qui in officiis omnis aliquam eaque. Aut sunt veritatis quis explicabo quidem doloremque. Aliquam aut consequuntur fuga exercitationem pariatur explicabo.</p>\n\n<p>Quia officiis asperiores debitis natus excepturi. Perspiciatis autem aut id provident. Voluptatum nesciunt optio reiciendis molestiae. Veritatis ut qui sed ea quisquam necessitatibus.</p>",
    "location": "285 Cassie Summit\nGottliebville, MO 30606",
    "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-09-06T02:01:00-05:00",
    "date_end": "2026-09-06T03:01:00-05:00",
    "timezone": "America/Chicago",
    "busy_type": null,
    "reminder_before": null,
    "date_range_formatted": "Sun, Sep 6, 2026 2:01 AM - 3:01 AM",
    "public_url": "http://addcal.co/e/rkpp3x41r8ih",
    "embed_url": "http://addcal.co/e/rkpp3x41r8ih",
    "location_url": null,
    "image_url": null,
    "timezone_readable": "CDT / GMT-05:00",
    "calendar": {
      "uid": "m9aokdxfmnhh",
      "public_id": "cal_m9aokdxfmnhh",
      "short_link": null,
      "name": "et alias optio",
      "internal_name": null,
      "description": "<p>Impedit mollitia corrupti corrupti repellat. Quia sunt distinctio illum voluptatum. Qui et esse voluptates pariatur.</p>",
      "timezone": "America/Campo_Grande",
      "week_begins": 6,
      "public_url": "http://addcal.co/c/m9aokdxfmnhh",
      "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/rkpp3x41r8ih",
    "auto": "https://addcal.co/e/rkpp3x41r8ih/auto",
    "google": "https://addcal.co/e/rkpp3x41r8ih/google",
    "apple": "https://addcal.co/e/rkpp3x41r8ih/apple",
    "outlook": "https://addcal.co/e/rkpp3x41r8ih/outlook",
    "outlook_web": "https://addcal.co/e/rkpp3x41r8ih/outlook_web",
    "yahoo": "https://addcal.co/e/rkpp3x41r8ih/yahoo",
    "office365": "https://addcal.co/e/rkpp3x41r8ih/office365",
    "ics": "https://addcal.co/e/rkpp3x41r8ih/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.