https://api.apyhub.com/generate/ical/file
POST
application/json
Attribute | Type | Mandatory | Description |
---|---|---|---|
output | String | No | The name of the generated .ics file. |
event_type | String | No | Defines the event type. Possible values are: - request (default): Creates a normal event (METHOD:REQUEST ). - cancel : Generates an event cancellation (METHOD:CANCEL , STATUS:CANCELLED ) |
Parameter | Type | Mandatory | Description |
---|---|---|---|
id | String | No | a unique identifier for the event (For example: 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. |
summary | String | No | The summary or title of the calendar event. |
description | String | Yes | The description of the calendar event. |
organizer_email | String | Yes | The email of the organizer of the event. |
attendees_emails | String Array | Yes | The emails of the event attendees. |
location | String | No | The location of the event. |
time_zone | String | Yes | Timezone for the event, use the timezone dictionary for this |
start_time | String | No | The start time of the event. |
end_time | String | No | The end time of the event. |
meeting_date | String | Yes | The date of the event. |
recurring | Boolean | No | Indicates if the meeting is a recurring meeting. The default value is false. If set to true, then you must provide the recurrence information. |
recurrence.frequency | ENUM | Yes (if recurring is true) | This is required only for recurring meetings : DAILY / WEEKLY / MONTHLY / YEARLY . |
recurrence.count | Integer | No | The number of times this event should recur. |
Status Code | Description |
---|---|
200 | The request was successful. |
401 | Required authentication information is either missing or not valid for the resource. |
400 | Invalid input or missing inputs. |
500 | If any unexpected error occurs while processing the request. |
tokens
or basic authentication
mechanisms.
You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".apy-token
as the header parameter to pass the token.Authorization
header to send the basic authentication credentials.