---
title: Generate iCal API
slug: generate-ical-event
url: https://apyhub.com/apyhub/service/generate-ical-event
provider: ApyHub
categories: [Output Kit]
tags: [events, ical, ics, calendar-invite, calendar, scheduling]
auth: api_key
version: 1.0.0
service_type: sync
endpoints: 2
atoms: 50
mcp: true
alias: generator-ical
---

# Generate iCal API

Create .ics calendar invites in your app. Send event details as JSON & get an iCal file that works in Google Calendar, Outlook & Apple Calendar. Free tier.

## Endpoints

| Method | URL | Description | Atoms |
| --- | --- | --- | --- |
| POST | `https://api.eu.apyhub.com/apyhub/generate-ical-event/download` | What it does Generates an iCal event file for the provided event details and returns it as a binary… | 50 |
| POST | `https://api.eu.apyhub.com/apyhub/generate-ical-event/link` | What it does Generates an iCal event file and returns a signed cloud URL to download the resulting… | 50 |

## Endpoint reference

### Generate iCal event — download file

`POST https://api.eu.apyhub.com/apyhub/generate-ical-event/download` · 50 atoms · accepts `application/json` · returns `application/json`

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | body | string | no | Event UID. Auto-generated if omitted. Example: `evt-2025-001`. |
| `all_day` | body | boolean | no | Generate an all-day event. Default: `false`. |
| `summary` | body | string | no | Event title. Example: `Team Sync`. |
| `end_time` | body | string | no | Time in HH:MM format. Ignored when all_day is true. Example: `10:00`. |
| `location` | body | string | no | Event location. Example: `Conference Room A`. |
| `sequence` | body | integer | no | iCal SEQUENCE number. Default: `0`. Example: `1`. |
| `recurring` | body | boolean | no | Whether the event recurs. Default: `false`. |
| `reminders` | body | array of object | no |  |
| `reminders[].action` | body | string | no | Reminder type. One of: display, email. Default: `display`. |
| `reminders[].description` | body | string | no | Reminder message. Default: `Reminder`. |
| `reminders[].minutes_before` | body | integer | yes | Minutes before event start the reminder fires. Example: `30`. |
| `time_zone` | body | string | no | IANA timezone identifier. Example: `Europe/London`. |
| `recurrence.count` | body | integer | no | Number of occurrences. Example: `10`. |
| `recurrence.interval` | body | integer | no | How often the recurrence rule repeats. Example: `1`. |
| `recurrence.frequency` | body | string | no | iCal FREQ value e.g. DAILY, WEEKLY, MONTHLY, YEARLY. Example: `WEEKLY`. |
| `start_time` | body | string | no | Time in HH:MM format. Ignored when all_day is true. Example: `09:00`. |
| `description` | body | string | no | Event description. Example: `Weekly team standup`. |
| `meeting_date` | body | string | no | Date in DD-MM-YYYY or YYYY-MM-DD format. Example: `15-06-2025`. |
| `organizer_email` | body | string (email) | no | Organizer email address. Example: `host@example.com`. |
| `attendees_emails` | body | array of string | no | List of attendee email addresses. |
| `output` | query | string | no | Override the default download filename (without extension). Example: `my-invite`. |
| `event_type` | query | string | no | Use 'cancel' to generate a VCALENDAR METHOD:CANCEL. One of: cancel. |

#### Quickstart

Generate a downloadable iCal event file from the event details in the request body.

```bash
curl -X POST "https://api.eu.apyhub.com/apyhub/generate-ical-event/download?output=my-invite" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "summary": "Team Sync",
  "description": "Weekly team sync to discuss project updates and action items.",
  "meeting_date": "2025-06-15",
  "start_time": "09:00",
  "end_time": "10:00",
  "location": "Conference Room A",
  "time_zone": "Europe/London",
  "organizer_email": "host@example.com",
  "attendees_emails": [
    "john.doe@example.com",
    "jane.smith@example.com"
  ]
}'
```

#### What you'll get back

Returns a binary file, which is the generated iCal download.

```bash
my-invite.ics
```

### Generate iCal event — return cloud link

`POST https://api.eu.apyhub.com/apyhub/generate-ical-event/link` · 50 atoms · accepts `application/json` · returns `application/json`

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | body | string | no | Event UID. Auto-generated if omitted. Example: `evt-2025-001`. |
| `all_day` | body | boolean | no | Generate an all-day event. Default: `false`. |
| `summary` | body | string | no | Event title. Example: `Team Sync`. |
| `end_time` | body | string | no | Time in HH:MM format. Ignored when all_day is true. Example: `10:00`. |
| `location` | body | string | no | Event location. Example: `Conference Room A`. |
| `sequence` | body | integer | no | iCal SEQUENCE number. Default: `0`. Example: `1`. |
| `recurring` | body | boolean | no | Whether the event recurs. Default: `false`. |
| `reminders` | body | array of object | no |  |
| `reminders[].action` | body | string | no | Reminder type. One of: display, email. Default: `display`. |
| `reminders[].description` | body | string | no | Reminder message. Default: `Reminder`. |
| `reminders[].minutes_before` | body | integer | yes | Minutes before event start the reminder fires. Example: `30`. |
| `time_zone` | body | string | no | IANA timezone identifier. Example: `Europe/London`. |
| `recurrence.count` | body | integer | no | Number of occurrences. Example: `10`. |
| `recurrence.interval` | body | integer | no | How often the recurrence rule repeats. Example: `1`. |
| `recurrence.frequency` | body | string | no | iCal FREQ value e.g. DAILY, WEEKLY, MONTHLY, YEARLY. Example: `WEEKLY`. |
| `start_time` | body | string | no | Time in HH:MM format. Ignored when all_day is true. Example: `09:00`. |
| `description` | body | string | no | Event description. Example: `Weekly team standup`. |
| `meeting_date` | body | string | no | Date in DD-MM-YYYY or YYYY-MM-DD format. Example: `15-06-2025`. |
| `organizer_email` | body | string (email) | no | Organizer email address. Example: `host@example.com`. |
| `attendees_emails` | body | array of string | no | List of attendee email addresses. |
| `output` | query | string | no | Override the default download filename (without extension). Example: `my-invite`. |
| `event_type` | query | string | no | Use 'cancel' to generate a VCALENDAR METHOD:CANCEL. One of: cancel. |

#### Quickstart

Generate a downloadable iCal file for a meeting by sending the event details in JSON.

```bash
curl -X POST "https://api.eu.apyhub.com/apyhub/generate-ical-event/link" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "summary": "Team Sync",
  "description": "Weekly team sync to discuss project updates and action items.",
  "meeting_date": "2025-06-15",
  "start_time": "09:00",
  "end_time": "10:00",
  "location": "Conference Room A",
  "time_zone": "Europe/London",
  "organizer_email": "host@example.com",
  "attendees_emails": [
    "john.doe@example.com",
    "jane.smith@example.com"
  ]
}'
```

#### What you'll get back

Returns a JSON object with a `data` string field containing a pre-signed URL to the generated `.ics` file.

```json
{
  "data": "https://storage.example.com/invite_2025-06-15_abc123.ics?sig=abc123"
}
```

## About

## What it does
The ICS Generator API creates calendar invite files (.ics) from event details you send as JSON. Add a title, date, start and end time, time zone, location, organizer, and attendees, and get back an iCal file that people can add to Google Calendar, Outlook, or Apple Calendar with one click.

It supports all-day events, recurring events (daily, weekly, monthly, or yearly), and reminders before the event starts. To cancel an event you already sent, generate a cancellation file with the same event `id` and `event_type` set to `cancel`.

Use it to attach calendar invites to booking confirmations, demo scheduling emails, webinar registrations, and team reminders. The API creates the file; your app sends it, for example as an email attachment or a download link. To check attendee addresses before sending, use the [Email Validation API](https://apyhub.com/apyhub/service/verify-email-validity-and-deliverability).

You can start on ApyHub's free tier with no card required.

## Usage

Base URL: `https://api.eu.apyhub.com` (default region — see
`GET https://apyhub.com/api/public/regions` for the rest).

Authenticate with an ApyHub API key in the `apy-token` header.
Full docs and a live playground: https://apyhub.com/apyhub/service/generate-ical-event
