Getting Started
Welcome to the CalendarInviteAPI Reference. If you're new to CalendarInviteAPI, create an account and follow this guide to get started.
API Request
- Base URL: https://calendarinviteapi.com/calendar/invite/
- Method: POST
- Params:
- invite_id: (required) The ID of your invite, it should be unique
- start_time: (required) The start time of your event, it should be a ISO 8601 format
- end_time: (required) The end time of your event, it should be a ISO 8601 format
- title: (required) The title of your event
- notes: (optional) The description of your event
- location: (optional) The location of your event
- zipcode: (optional) The zipcode of your event's location
- organizer: (optional) The organizer's name
- webhook_url: (optional) The webhook endpoint to receive the RSVP
- recipients: (required) The recipient(s) of your event, it should be a list and the format like:
[ {'email': 'email1@example.com'}, {'email': 'email2@example.com'} ] - token: (required) Your project token. You can get the token from your account page
Example (Python)
# An example for Python language
import requests
data = {
'invite_id': 'test_id_1', # it should be unique
'title': 'This is the event title',
'start_time': '2024-04-06T12:45:00+04:00', # ISO 8601 format
'end_time': '2024-04-06T13:45+04:00', # ISO 8601 format
'notes': 'This is the event notes',
'location': 'Maine - USA',
'recipients': [
{'email': 'email1@example.com'},
{'email': 'email2@example.com'},
],
'webhook_url': '<your_site>/calendar/webhook/', # your webhook endpoint to receive the RSVP
'token': '<your_token_here>', # your project token
}
ics_file = requests.post(
'https://calendarinviteapi.com/calendar/invite/',
json=data,
)
Questions
Email help@calendarinviteapi.com and we'll be happy to help you with your integration