apyhub-logo
CatalogPricingBlog
Log in

Generate iCal

Smart Generation#events#ical
50 atoms
Base tier

About

This Utility API lets you generate iCal calendar events that can be used across calendar applications and platforms.
This API generates calendars in the iCalendar format (RFC 5545), a textual format that can be loaded by different applications. The API lets you create single or recurring events with support for any time zone. The API creates a .ics file that you can use to add the event to Google Calendar, Microsoft Outlook, Apple iPhone and other Calendars.
Endpoint Selector
Output

API Playground

This API endpoint does not have a playground yet. Please check back later.

Documentation

download file
POST
https://api.apyhub.com/generate/ical/file

Request example

1
```cURL
2
curl --location --request POST 'https://api.apyhub.com/generate/ical/file?output=invite.ics' \
3
--header 'Content-Type: application/json' \
4
--header 'apy-token: {{token}}' \
5
--data-raw '{
6
    "summary":"Final Call",
7
    "description":"Casting for the New James Bond Movie",
8
    "organizer_email":"johndoe@apyhub.com",
9
    "attendees_emails":["mark@apyhub.com"],
10
    "location":"US",
11
    "time_zone": "Europe/Helsinki",
12
    "start_time":"08:00",
13
    "end_time":"09:00",
14
    "meeting_date":"30-11-2022",
15
    "recurring":true,
16
    "recurrence":{
17
            "frequency": "WEEKLY",
18
            "count" : 2
19
        }
20
}'
Method: POST
Content Type: application/json
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe name for the generated ics file
Request Body
ParameterTypeMandatoryDescription
idStringNoa unique identifier for the event (e.g UUID). By default a UUID is created, if the id is not passed. If you pass the id then you can create an event using that ID and update the event by passing the same id, in case the event needs to be rescheduled or if any changes needed to be made.
summaryStringNoThe summary or title of the calendar event.
descriptionStringYesThe description of the calendar event.
organizer_emailStringYesThe email of the organizer of the event.
attendees_emailsString ArrayYesThe emails of the event attendees.
locationStringNoThe location of the event.
time_zoneStringYesTimezone for the event, use the timezone dictionary for this
start_timeStringYesThe start time of the event.
end_timeStringYesThe end time of the event.
meeting_dateStringYesThe date of the event.
recurringBooleanNoIndicates if the meeting is a recurring meeting. The default value is false. If set to true, then you must provide the recurrence information.
recurrence.frequencyENUMYes (if recurring is true)This is required only for recurring meetings. DAILY / WEEKLY / MONTHLY / YEARLY
recurrence.countIntegerNoThe number of times this event should recur

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
400Invalid input or missing inputs
500If any unexpected error occurs while processing the request

Authentication

All requests to ApyHub services need to be authenticated, currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.