Solutions
- Automated add to calendar button for websites
- Automated add to calendar links for emails
- Calendar & Events API v2
-
Calendar API Deprecated
- List calendars
- Create a calendar
- Save a calendar
- Delete a calendar
- List events in a calendar
- List all events across all calendars
- Create an event in a calendar
- Save an event in a calendar
- Delete an event in a calendar
- List calendar subscribers
- View a subscriber
- Delete a subscriber
- List of time zones
- Events API Deprecated
- Useful Tools
Back to Documentation
Events API
We released an updated version of our API in November 2023. While these endpoints are still supported, they will be deprecated over the coming months, and so we reccommend using the new API going forward. Documentation for the updated calendar and event APIs can be found here: API v2 Documentation
warning
The API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.
All API access is over HTTPS. All data is received as JSON, including errors.
Data
Please URL encode all parameter values.
The API requires an API token to work.
Please sign in or
create an account to receive your
accounts API tokens.
List events
Returns a list of events in a calendar. The events are sorted by recently created.
$ curl https://www.addevent.com/api/v1/oe/events/list/?token=token&calendar_id=calendar_id
$ curl https://www.addevent.com/api/v1/oe/events/list/?token=USER-TOKEN-ID&calendar_id=1473327868906
Returns
{
"meta": {
"code": "200"
},
"calendar": {
"id": "1473327868906",
"events_count": 33,
"link_short": "http:\/\/cal.ae\/eoadiew",
"link_long": "https:\/\/www.addevent.com\/calendar\/pg261852"
},
"events": [{
"id": "125163",
"title": "Title of the event",
"eventname": "Title of the event",
"description": "Description of the event",
"location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
"organizer": "Thomas Scott",
"organizer_email": "thomas@example.com",
"date_start": "10\/21\/2024",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_start_unix": 1729501200,
"date_end": "",
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"date_end_unix": 1729508400,
"all_day_event": "false",
"date_format": "MM\/DD\/YYYY",
"timezone": "America\/Los_Angeles",
"reminder": "60",
"rrule": "",
"updated_times": "0",
"rsvp_require": "true",
"rsvp_template_id": "",
"rsvp_seat_limited": "true",
"rsvp_seat_limit": "50",
"rsvp_seats_left": "45",
"rsvp_inactive": "false",
"rsvp_notify": "email@example.org",
"rsvp_count": "8",
"rsvp_attn_going": "5",
"rsvp_attn_maybe": "2",
"rsvp_attn_cantgo": "1",
"color": "2",
"transp": "busy",
"custom_data": "",
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1729501200,
"date_modified": 1729501200
}, {
"id": "125162",
"title": "Title of the event",
"eventname": "Title of the event",
"description": "Description of the event",
"location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
"organizer": "Thomas Scott",
"organizer_email": "thomas@example.com",
"date_start": "10\/14\/2024",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_start_unix": 1728896400,
"date_end": "10\/14\/2024",
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"date_end_unix": 1728903600,
"all_day_event": "false",
"date_format": "MM\/DD\/YYYY",
"timezone": "America\/Los_Angeles",
"reminder": "60",
"rrule": "",
"updated_times": "0",
"rsvp_require": "true",
"rsvp_template_id": "",
"rsvp_seat_limited": "true",
"rsvp_seat_limit": "50",
"rsvp_seats_left": "45",
"rsvp_inactive": "false",
"rsvp_notify": "email@example.org",
"rsvp_count": "8",
"rsvp_attn_going": "5",
"rsvp_attn_maybe": "2",
"rsvp_attn_cantgo": "1",
"color": "2",
"transp": "busy",
"custom_data": "",
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1729501200,
"date_modified": 1729501200 }],
"paging": {
"previous": "",
"next": "https:\/\/www.addevent.com\/api\/v1\/oe\/events\/list\/?token=USER-TOKEN-ID&page=2"
}
}
Parameter
Description
token
Required
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
calendar_id
Optional
Id of the calendar. If a calendar ID is not specified the "Main Calendar" is used.
Id of the calendar. If a calendar ID is not specified the "Main Calendar" is used.
order_by
List events in the calendar in a specific order.
Accepts: date-asc or date-desc or id-asc or id-desc
Example: &order_by=date-desc
Accepts: date-asc or date-desc or id-asc or id-desc
Example: &order_by=date-desc
month + year
List events in the calendar in a specific month of the year.
Accepts: month combined with year. Month must contain two digits (from 01-12) and year must contain four digits, e.g. "2020".
Example: &month=06&year=2020
Accepts: month combined with year. Month must contain two digits (from 01-12) and year must contain four digits, e.g. "2020".
Example: &month=06&year=2020
upcoming
List upcoming events in the calendar from "now" or from a specific date/time value. Please notice: This parameter set "order_by" to "date-asc" by default.
Accepts: now or a date/time. Date/time can be the following format:
"2020-11-31 17:30:00" or "31-11-2020 11:00:00" or "2020/11/31 09:37am" or "11/31/2020 03:05pm".
Example: &upcoming=now" or "&upcoming=2020/11/31 12:01pm
Example: &upcoming=now" or "&upcoming=2020/11/31 12:01pm
Create an event in a calendar
Creates an event in a calendar. Returns the event created.
$ curl https://www.addevent.com/api/v1/oe/events/create/?token=token&calendar_id=calendar_id&title=title&eventname=eventname&description=description&location=location&organizer=organizer&organizer_email=organizer_email&timezone=timezone&reminder=reminder&start_date=start_date&end_date=end_date&all_day_event=all_day_event&rsvp_require=rsvp_require&rsvp_template_id=rsvp_template_id&custom_data=custom_data
$ curl https://www.addevent.com/api/v1/oe/events/create/?token=USER-TOKEN-ID&calendar_id=1473327868906&title=Title+of+the+event&eventname=Title+of+the+event&description=Description+of+the+event&location=1600+Amphitheatre+Pkwy%2C+Mountain+View%2C+CA+94043&organizer=Thomas+Scott&organizer_email=thomas%40example.com&timezone=America%2FLos_Angeles&reminder=60&start_date=12%2F05%2F2024+09%3A00&end_date=12%2F05%2F202411%3A00&all_day_event=false&rsvp_require=true&rsvp_template_id=p39osKtoqR&custom_data= Returns
{
"meta": {
"code": "200"
},
"event": {
"id": 324058,
"calendar": "1473327868906",
"uniquekey": "GV160458",
"title": "Title of the event",
"eventname": "Title of the event",
"description": "Description of the event",
"location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
"organizer": "Thomas Scott",
"organizer_email": "thomas@example.com",
"date_start": "12\/05\/2024",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_end": "12\/05\/2024",
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"all_day_event": "false",
"date_format": "MM\/DD\/YYYY",
"timezone": "America\/Los_Angeles",
"reminder": "60",
"rrule": "",
"template_id": "a20418bkd038dkO",
"color": "2",
"transp": "busy",
"updated_times": "0",
"rsvp_require": "true",
"rsvp_template_id": "p39osKtoqR",
"custom_data": "",
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1733389200,
"date_modified": 1733389200 }
}
Parameter
Description
token
Required
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
calendar_id
Optional
Id of the calendar to create the event in. If a calendar ID is not specified the "Main Calendar" is used.
Id of the calendar to create the event in. If a calendar ID is not specified the "Main Calendar" is used.
title
Required
Title of the event. Single line string.
Title of the event. Single line string.
eventname
Name of the event. Use for internal purpose only.
description
Description of the event. Use \n to separate lines.
The field accepts plain text or simplified HTML. Simplified HTML is supported by calendar clients like Outlook and Apple Calendar. If the calendar client does accept HTML, the content of the field is automatically converted into readable text.
Keep the description short and to the point. Link to a website for further details if the event description is long. Maximum 500 characters recommended.
Reason: Most modern browsers allow an unlimited number of characters to be transfered by the browser. Internet Explorer / Edge only allows ~2000 characters. A 500 characters maximum is recommended to make sure your event is cross browser compatible.
The field accepts plain text or simplified HTML. Simplified HTML is supported by calendar clients like Outlook and Apple Calendar. If the calendar client does accept HTML, the content of the field is automatically converted into readable text.
Keep the description short and to the point. Link to a website for further details if the event description is long. Maximum 500 characters recommended.
Reason: Most modern browsers allow an unlimited number of characters to be transfered by the browser. Internet Explorer / Edge only allows ~2000 characters. A 500 characters maximum is recommended to make sure your event is cross browser compatible.
location
Location of the event, e.g. "1600 Amphitheatre Pkwy, Mountain View, CA 94043".
organizer
Event organizer, e.g. "Thomas Scott".
If you fill out organizer you must also include the organizer_email field.
If you include an organizer and an organizer_email, the event is considered to be a "meeting" by calendar clients like Outlook. If you don't include the fields, the event is considered to be an "appointment".
If you fill out organizer you must also include the organizer_email field.
If you include an organizer and an organizer_email, the event is considered to be a "meeting" by calendar clients like Outlook. If you don't include the fields, the event is considered to be an "appointment".
organizer_email
Event organizer e-mail, e.g. "thomas@example.com".
If you fill out organizer_email you must also include the organizer field.
If you include an organizer and an organizer_email, the event is considered to be a "meeting" by calendar clients like Outlook. If you don't include the fields, the event is considered to be an "appointment".
If you fill out organizer_email you must also include the organizer field.
If you include an organizer and an organizer_email, the event is considered to be a "meeting" by calendar clients like Outlook. If you don't include the fields, the event is considered to be an "appointment".
start_date
Required
Start date of the event. Accepts most date/time formats, e.g. 11/21/2024 03:00 PM (12-hour format) or 21-11-2024 15:00 (24-hour format).
Use numeric values to describe the date, e.g. "12/05/2024" and not textual, e.g. "December 5th, 2024".
Dates in the m/d/y or d-m-y formats are disambiguated by looking at the separator between the various components: if the separator is a slash (/), then the American m/d/y is assumed; whereas if the separator is a dash (-) or a dot (.), then the European d-m-y format is assumed. If, however, the year is given in a two digit format and the separator is a dash (-, the date string is parsed as y-m-d. To avoid potential ambiguity, it's best to use ISO 8601 (YYYY-MM-DD) dates
Date examples:
11/21/2024 03:00 PM or 21-11-2024 15:00 or 2024/11/21 03:00 PM or 2024-11-21 15:00
Start date of the event. Accepts most date/time formats, e.g. 11/21/2024 03:00 PM (12-hour format) or 21-11-2024 15:00 (24-hour format).
Use numeric values to describe the date, e.g. "12/05/2024" and not textual, e.g. "December 5th, 2024".
Dates in the m/d/y or d-m-y formats are disambiguated by looking at the separator between the various components: if the separator is a slash (/), then the American m/d/y is assumed; whereas if the separator is a dash (-) or a dot (.), then the European d-m-y format is assumed. If, however, the year is given in a two digit format and the separator is a dash (-, the date string is parsed as y-m-d. To avoid potential ambiguity, it's best to use ISO 8601 (YYYY-MM-DD) dates
Date examples:
11/21/2024 03:00 PM or 21-11-2024 15:00 or 2024/11/21 03:00 PM or 2024-11-21 15:00
end_date
End date of the event.
Accepts most date/time formats, e.g. 11/21/2024 05:00 PM (12-hour format) or
21-11-2024 17:00 (24-hour format).
Use numeric values to describe the date, e.g. "12/05/2024" and not textual, e.g. "December 5th, 2024".
Dates in the m/d/y or d-m-y formats are disambiguated by looking at the separator between the various components: if the separator is a slash (/), then the American m/d/y is assumed; whereas if the separator is a dash (-) or a dot (.), then the European d-m-y format is assumed. If, however, the year is given in a two digit format and the separator is a dash (-, the date string is parsed as y-m-d. To avoid potential ambiguity, it's best to use ISO 8601 (YYYY-MM-DD) dates
Date examples:
11/21/2024 05:00 PM or 21-11-2024 17:00 or 2024/11/21 05:00 PM or 2017-03-17 17:00
If end is not defined, the end date is automatically set to start date plus one hour.
Use numeric values to describe the date, e.g. "12/05/2024" and not textual, e.g. "December 5th, 2024".
Dates in the m/d/y or d-m-y formats are disambiguated by looking at the separator between the various components: if the separator is a slash (/), then the American m/d/y is assumed; whereas if the separator is a dash (-) or a dot (.), then the European d-m-y format is assumed. If, however, the year is given in a two digit format and the separator is a dash (-, the date string is parsed as y-m-d. To avoid potential ambiguity, it's best to use ISO 8601 (YYYY-MM-DD) dates
Date examples:
11/21/2024 05:00 PM or 21-11-2024 17:00 or 2024/11/21 05:00 PM or 2017-03-17 17:00
If end is not defined, the end date is automatically set to start date plus one hour.
timezone
Required
The events time zone, e.g. Europe/Paris or America/Los_Angeles.
The timezone parameter defaults to the calendars time zone or "America/Los_Angeles" if a timezone is not defined.
You can find a list of all time zones (Section: List of time zones) at the bottom of this page.
Explanation: The timezone parameter makes sure the date/time is correct no matter if you are in New York or Sydney.
The events time zone, e.g. Europe/Paris or America/Los_Angeles.
The timezone parameter defaults to the calendars time zone or "America/Los_Angeles" if a timezone is not defined.
You can find a list of all time zones (Section: List of time zones) at the bottom of this page.
Explanation: The timezone parameter makes sure the date/time is correct no matter if you are in New York or Sydney.
all_day_event
All day event. Accepts true or false.
reminder
Event reminder. Trigger an event reminder e.g. "15" minutes before the event starts.
Accepted input: Number
Example: Reminder "15" minutes before event starts = 15 or
one day before event starts : 60 minutes x 24 hours = 1440.
Event reminders are currently supported by:
- Apple Calendar
- Office 365 (using the Microsoft Events API)
- Outlook
- Outlook.com (using the Microsoft Events API)
Accepted input: Number
Example: Reminder "15" minutes before event starts = 15 or
one day before event starts : 60 minutes x 24 hours = 1440.
Event reminders are currently supported by:
- Apple Calendar
- Office 365 (using the Microsoft Events API)
- Outlook
- Outlook.com (using the Microsoft Events API)
rrule
Recurring rule, e.g. FREQ=WEEKLY;UNTIL=20241110T080000Z;BYDAY=WE,TH,FR
Make the event repeat for a number of times.
Generate Recurring Rule
Recurring rules are advanced and needs to be tested before you publish it. Please notice: The start date/time must match the recurrence rule in order to work in strict calendar systems like Outlook and Apple Calendar.
Recurring rules are currently supported by:
- Apple Calendar
- Google Calendar (using "Direct" and Google Events API)
- Office 365 (using the Microsoft Events API)
- Outlook
- Outlook.com (using Microsoft Events API)
Generate Recurring Rule
Recurring rules are advanced and needs to be tested before you publish it. Please notice: The start date/time must match the recurrence rule in order to work in strict calendar systems like Outlook and Apple Calendar.
Recurring rules are currently supported by:
- Apple Calendar
- Google Calendar (using "Direct" and Google Events API)
- Office 365 (using the Microsoft Events API)
- Outlook
- Outlook.com (using Microsoft Events API)
template_id
ID of a "Custom Event Page" template, e.g. "a20418bkd038dkO". Uses the "AddEvent default" template if template_id is not defined.
In order to create/access custom templates please go to the Custom Templates for events page.
rsvp_require
Whether the event requires RSVP or not. Optional. Accepts true or false.
rsvp_template_id
ID of the RSVP template to use. Optional. If no template ID is specified the event uses the "Standard RSVP template".
RSVP templates can be created manually in the "Events" section.
custom_data
Allows you to save a JSON string containing keys and values which can be used with a custom event templates.
E.g. {"name":"Michael","bannerimage":"https://example.org/.../banner1.jpg"}
The system will collect the keys in the JSON string and make the keys/values available in the template markup.
E.g. use {{name}} or {{bannerimage}} to output the variables in your custom template.
Requires valid JSON. Max length of JSON string is 500 characters.
E.g. {"name":"Michael","bannerimage":"https://example.org/.../banner1.jpg"}
The system will collect the keys in the JSON string and make the keys/values available in the template markup.
E.g. use {{name}} or {{bannerimage}} to output the variables in your custom template.
Requires valid JSON. Max length of JSON string is 500 characters.
color
Color of the event as pre-defined in the calendar settings. Accepts 1 to 20.
transp
Determines whether the event appears as "free" or "busy" on the users calendar. Accepts transparent or opaque.
By default, events are set to "free". If the "transp" value doesn't contain any data, the event is "free".
Save an event
Save an event in a calendar. Returns the event saved.
$ curl https://www.addevent.com/api/v1/oe/events/save/?token=token&event_id=event_id&title=title&eventname=eventname&description=description&location=location&organizer=organizer&organizer_email=organizer_email&timezone=timezone&reminder=reminder&start_date=start_date&end_date=end_date&all_day_event=all_day_event&rsvp_require=rsvp_require&rsvp_template_id=rsvp_template_id&custom_data=custom_data
$ curl https://www.addevent.com/api/v1/oe/events/save/?token=USER-TOKEN-ID&event_id=159051&title=Title+of+the+event&eventname=Title+of+the+event&description=Description+of+the+event&location=1600+Amphitheatre+Pkwy%2C+Mountain+View%2C+CA+94043&organizer=Thomas+Scott&organizer_email=thomas%40example.com&timezone=America%2FLos_Angeles&reminder=60&start_date=12%2F05%2F2024+09%3A00&end_date=12%2F05%2F202411%3A00&all_day_event=false&rsvp_require=true&rsvp_template_id=p39osKtoqR&custom_data= Returns
{
"meta": {
"code": "200"
},
"event": {
"id": 159051,
"calendar": "1473327868906",
"uniquekey": "GV160458",
"title": "Title of the event",
"eventname": "Title of the event",
"description": "Description of the event",
"location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
"organizer": "Thomas Scott",
"organizer_email": "thomas@example.com",
"date_start": "12\/05\/2024",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_end": "12\/05\/2024",
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"all_day_event": "false",
"date_format": "MM\/DD\/YYYY",
"timezone": "America\/Los_Angeles",
"reminder": "60",
"rrule": "",
"template_id": "a20418bkd038dkO",
"color": "2",
"transp": "busy",
"updated_times": "1",
"rsvp_require": "true",
"rsvp_template_id": "p39osKtoqR",
"custom_data": "",
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1733389200,
"date_modified": 1733389200 }
}
Parameter
Description
token
Required
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
event_id
Required
Id of the event.
Id of the event.
title
Required
Title of the event. Single line string.
Title of the event. Single line string.
eventname
Name of the event. Use for internal purpose only.
description
Description of the event. Use \n to separate lines.
The field accepts plain text or simplified HTML. Simplified HTML is supported by calendar clients like Outlook and Apple Calendar. If the calendar client does accept HTML, the content of the field is automatically converted into readable text.
Keep the description short and to the point. Link to a website for further details if the event description is long. Maximum 500 characters recommended.
Reason: Most modern browsers allow an unlimited number of characters to be transfered by the browser. Internet Explorer / Edge only allows ~2000 characters. A 500 characters maximum is recommended to make sure your event is cross browser compatible.
The field accepts plain text or simplified HTML. Simplified HTML is supported by calendar clients like Outlook and Apple Calendar. If the calendar client does accept HTML, the content of the field is automatically converted into readable text.
Keep the description short and to the point. Link to a website for further details if the event description is long. Maximum 500 characters recommended.
Reason: Most modern browsers allow an unlimited number of characters to be transfered by the browser. Internet Explorer / Edge only allows ~2000 characters. A 500 characters maximum is recommended to make sure your event is cross browser compatible.
location
Location of the event, e.g. "1600 Amphitheatre Pkwy, Mountain View, CA 94043".
organizer
Event organizer, e.g. "Thomas Scott".
If you fill out organizer you must also include the organizer_email field.
If you include an organizer and an organizer_email, the event is considered to be a "meeting" by calendar clients like Outlook. If you don't include the fields, the event is considered to be an "appointment".
If you fill out organizer you must also include the organizer_email field.
If you include an organizer and an organizer_email, the event is considered to be a "meeting" by calendar clients like Outlook. If you don't include the fields, the event is considered to be an "appointment".
organizer_email
Event organizer e-mail, e.g. "thomas@example.com".
If you fill out organizer_email you must also include the organizer field.
If you include an organizer and an organizer_email, the event is considered to be a "meeting" by calendar clients like Outlook. If you don't include the fields, the event is considered to be an "appointment".
If you fill out organizer_email you must also include the organizer field.
If you include an organizer and an organizer_email, the event is considered to be a "meeting" by calendar clients like Outlook. If you don't include the fields, the event is considered to be an "appointment".
start_date
Required
Start date of the event. Accepts most date/time formats, e.g. 11/21/2024 03:00 PM (12-hour format) or 21-11-2024 15:00 (24-hour format).
Use numeric values to describe the date, e.g. "12/05/2024" and not textual, e.g. "December 5th, 2024".
Dates in the m/d/y or d-m-y formats are disambiguated by looking at the separator between the various components: if the separator is a slash (/), then the American m/d/y is assumed; whereas if the separator is a dash (-) or a dot (.), then the European d-m-y format is assumed. If, however, the year is given in a two digit format and the separator is a dash (-, the date string is parsed as y-m-d. To avoid potential ambiguity, it's best to use ISO 8601 (YYYY-MM-DD) dates
Date examples:
11/21/2024 03:00 PM or 21-11-2024 15:00 or 2024/11/21 03:00 PM or 2024-11-21 15:00
Start date of the event. Accepts most date/time formats, e.g. 11/21/2024 03:00 PM (12-hour format) or 21-11-2024 15:00 (24-hour format).
Use numeric values to describe the date, e.g. "12/05/2024" and not textual, e.g. "December 5th, 2024".
Dates in the m/d/y or d-m-y formats are disambiguated by looking at the separator between the various components: if the separator is a slash (/), then the American m/d/y is assumed; whereas if the separator is a dash (-) or a dot (.), then the European d-m-y format is assumed. If, however, the year is given in a two digit format and the separator is a dash (-, the date string is parsed as y-m-d. To avoid potential ambiguity, it's best to use ISO 8601 (YYYY-MM-DD) dates
Date examples:
11/21/2024 03:00 PM or 21-11-2024 15:00 or 2024/11/21 03:00 PM or 2024-11-21 15:00
end_date
End date of the event.
Accepts most date/time formats, e.g. 11/21/2024 05:00 PM (12-hour format) or
21-11-2024 17:00 (24-hour format).
Use numeric values to describe the date, e.g. "12/05/2024" and not textual, e.g. "December 5th, 2024".
Dates in the m/d/y or d-m-y formats are disambiguated by looking at the separator between the various components: if the separator is a slash (/), then the American m/d/y is assumed; whereas if the separator is a dash (-) or a dot (.), then the European d-m-y format is assumed. If, however, the year is given in a two digit format and the separator is a dash (-, the date string is parsed as y-m-d. To avoid potential ambiguity, it's best to use ISO 8601 (YYYY-MM-DD) dates
Date examples:
11/21/2024 05:00 PM or 21-11-2024 17:00 or 2024/11/21 05:00 PM or 2017-03-17 17:00
If end is not defined, the end date is automatically set to start date plus one hour.
Use numeric values to describe the date, e.g. "12/05/2024" and not textual, e.g. "December 5th, 2024".
Dates in the m/d/y or d-m-y formats are disambiguated by looking at the separator between the various components: if the separator is a slash (/), then the American m/d/y is assumed; whereas if the separator is a dash (-) or a dot (.), then the European d-m-y format is assumed. If, however, the year is given in a two digit format and the separator is a dash (-, the date string is parsed as y-m-d. To avoid potential ambiguity, it's best to use ISO 8601 (YYYY-MM-DD) dates
Date examples:
11/21/2024 05:00 PM or 21-11-2024 17:00 or 2024/11/21 05:00 PM or 2017-03-17 17:00
If end is not defined, the end date is automatically set to start date plus one hour.
timezone
Required
The events time zone, e.g. Europe/Paris or America/Los_Angeles.
The timezone parameter converts the date/time to Zulu time / GMT / UTC. The timezone parameter defaults to "America/Los_Angeles" if a timezone is not defined.
You can find a list of all time zones (Section: List of time zones) at the bottom of this page.
Explanation: The timezone parameter makes sure the date/time is correct no matter if you are in New York or Sydney.
The events time zone, e.g. Europe/Paris or America/Los_Angeles.
The timezone parameter converts the date/time to Zulu time / GMT / UTC. The timezone parameter defaults to "America/Los_Angeles" if a timezone is not defined.
You can find a list of all time zones (Section: List of time zones) at the bottom of this page.
Explanation: The timezone parameter makes sure the date/time is correct no matter if you are in New York or Sydney.
all_day_event
All day event. Accepts true or false.
reminder
Event reminder. Trigger an event reminder e.g. "15" minutes before the event starts.
Accepted input: Number
Example: Reminder "15" minutes before event starts = 15 or
one day before event starts : 60 minutes x 24 hours = 1440.
Event reminders are currently supported by:
- Apple Calendar
- Outlook
Accepted input: Number
Example: Reminder "15" minutes before event starts = 15 or
one day before event starts : 60 minutes x 24 hours = 1440.
Event reminders are currently supported by:
- Apple Calendar
- Outlook
rrule
Recurring rule, e.g. FREQ=WEEKLY;UNTIL=20241110T080000Z;BYDAY=WE,TH,FR
Make the event repeat for a number of times.
Generate Recurring Rule
Recurring rules are advanced and needs to be tested before you publish it. Please notice: The start date/time must match the recurrence rule in order to work in strict calendar systems like Outlook and Apple Calendar.
Recurring rules are currently supported by:
- Apple Calendar
- Google Calendar (using "Direct" and Google Events API)
- Office 365 (using the Microsoft Events API)
- Outlook
- Outlook.com (using Microsoft Events API)
Generate Recurring Rule
Recurring rules are advanced and needs to be tested before you publish it. Please notice: The start date/time must match the recurrence rule in order to work in strict calendar systems like Outlook and Apple Calendar.
Recurring rules are currently supported by:
- Apple Calendar
- Google Calendar (using "Direct" and Google Events API)
- Office 365 (using the Microsoft Events API)
- Outlook
- Outlook.com (using Microsoft Events API)
template_id
ID of a "Custom Event Page" template, e.g. "a20418bkd038dkO". Uses the "AddEvent default" template if template_id is not defined.
In order to create/access custom templates please go to the Custom Templates for events page.
rsvp_require
Whether the event requires RSVP or not. Optional. Accepts true or false.
rsvp_template_id
ID of the RSVP template to use. Optional. If no template ID is specified the event uses the "Standard RSVP template".
RSVP templates can be created manually in the "Events" section.
custom_data
Allows you to save a JSON string containing keys and values which can be used with a custom event templates.
E.g. {"name":"Michael","bannerimage":"https://example.org/.../banner1.jpg"}
The system will collect the keys in the JSON string and make the keys/values available in the template markup.
E.g. use {{name}} or {{bannerimage}} to output the variables in your custom template.
Requires valid JSON. Max length of JSON string is 500 characters.
E.g. {"name":"Michael","bannerimage":"https://example.org/.../banner1.jpg"}
The system will collect the keys in the JSON string and make the keys/values available in the template markup.
E.g. use {{name}} or {{bannerimage}} to output the variables in your custom template.
Requires valid JSON. Max length of JSON string is 500 characters.
color
Color of the event as pre-defined in the calendar settings. Accepts 1 to 20.
transp
Determines whether the event appears as "free" or "busy" on the users calendar. Accepts transparent or opaque.
By default, events are set to "free". If the "transp" value doesn't contain any data, the event is "free".
Delete an event
Deletes an event in a calendar. Returns a deletion status.
$ curl https://www.addevent.com/api/v1/oe/events/delete/?token=token&event_id=event_id
$ curl https://www.addevent.com/api/v1/oe/events/delete/?token=USER-TOKEN-ID&event_id=159051
Returns
{
"meta": {
"code": "200"
},
"event": {
"id": "159051",
"status": "deleted"
}
}
Parameter
Description
token
Required
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
event_id
Required
Id of the event.
Id of the event.
View an event
View details about an event in a calendar. Returns the event details.
$ curl https://www.addevent.com/api/v1/oe/events/event/?token=token&event_id=event_id
$ curl https://www.addevent.com/api/v1/oe/events/event/?token=USER-TOKEN-ID&event_id=159051
Returns
{
"meta": {
"code": "200"
},
"event": {
"id": "997204",
"calendar": "1473327868906",
"unique": "pM997204",
"title": "Title of the event (example with RSVP)",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque euismod scelerisque ex, bibendum semper nulla consectetur nec. Ut rhoncus imperdiet urna, in mollis tortor mollis eu. Ut euismod rutrum gravida. Donec molestie aliquet nisl, vitae ullamcorper magna feugiat vel. Etiam eu blandit risus. Morbi et dolor id felis maximus pellentesque.",
"location": "18 Bartol Street, San Francisco, CA 94133, USA",
"organizer": "AddEvent.com",
"organizer_email": "events@addevent.com",
"date_start": "11\/20\/2018",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_start_unix": 1542700800,
"date_end": "11\/20\/2018",
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"date_end_unix": 1542708000,
"all_day_event": "false",
"date_format": "MM\/DD\/YYYY",
"timezone": "America\/Los_Angeles",
"reminder": "0",
"rrule": "",
"template_id": "a20418bkd038dkO",
"color": "2",
"transp": "busy",
"updated_times": "7",
"rsvp_require": "true",
"rsvp_template_id": "17zJBMGvbswn",
"rsvp_seat_limited": "true",
"rsvp_seat_limit": "50",
"rsvp_seats_left": "45",
"rsvp_inactive": "false",
"rsvp_notify": "email@example.org",
"rsvp_count": "8",
"rsvp_attn_going": "5",
"rsvp_attn_maybe": "2",
"rsvp_attn_cantgo": "1",
"custom_data": "",
"date_create": 1522771966,
"date_modified": 1538410290,
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744"
}
}
Parameter
Description
token
Required
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
event_id
Required
Id of the event.
Id of the event.
List RSVP's of an event
Returns a list of attendees who have RSVP'ed for an event in a calendar. The attendees are sorted by recently created.
$ curl https://www.addevent.com/api/v1/oe/rsvps/list/?token=token&event_id=event_id
$ curl https://www.addevent.com/api/v1/oe/rsvps/list/?token=USER-TOKEN-ID&event_id=159051
Returns
{
"meta": {
"code": "200"
},
"summary": {
"rsvp_count": 2,
"going": "1",
"maybe": "1",
"cant_go": "0"
},
"rsvps": {
"header": {
"attending": "Attending",
"name": "Name",
"email": "Email",
"ip": "IP",
"city": "City",
"region": "Region",
"country": "Country",
"location": "Location",
"postal": "Postal",
"userid": "System Id",
"createdate": "Create date",
"modifydate": "Last save date"
},
"attendees": [{
"attending": "Going",
"attending_code": "1",
"name": "Sam Smith",
"email": "sam@example.org",
"ip": "",
"city": "Rybnik",
"region": "Silesia",
"country": "PL",
"location": "",
"postal": "44-203",
"userid": "VtgTLlUv17823",
"createdate": "Oct 2nd 2018 09:26am (UTC)",
"modifydate": "Oct 2nd 2018 09:26am (UTC)"
}, {
"attending": "Maybe",
"attending_code": "2",
"name": "Scott Flynn",
"email": "scott@example.org",
"ip": "24.xxx.111.44",
"city": "Laval",
"region": "Quebec",
"country": "CA",
"location": "45.5793,-73.7367",
"postal": "H7S",
"userid": "eILFqBUg17579",
"createdate": "Sep 28th 2018 18:30pm (UTC)",
"modifydate": "Oct 1st 2018 18:11pm (UTC)"
}]
},
"paging": {
"previous": "",
"next": ""
}
}
Parameter
Description
token
Required
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
event_id
Required
Id of the event.
Id of the event.
Sorting
Parameter
Description
page
If the list of RSVP attendees contain more than 20 records the results
are paginated. Use the page parameter to go through the next page of results.
Example:
Example:
$ curl https://www.addevent.com/api/v1/oe/rsvps/list/?token=USER-TOKEN-ID&event_id=159051&page=2
attending
Use the attending parameter to list only attendees who
is "Attending" (shortcode: "1") or have answered "Maybe" (shortcode: "2") or
"Can't go" (shortcode: "3"). If you want to list attendees who are "Attending" plus
have answered "Maybe" use shortcode "12".
Example:
Example:
$ curl https://www.addevent.com/api/v1/oe/rsvps/list/?token=USER-TOKEN-ID&event_id=159051&attending=1
View an RSVP attendee
Returns details about an RSVP attendee.
$ curl https://www.addevent.com/api/v1/oe/rsvps/attendee/?token=token&event_id=event_id&user_id=user_id
$ curl https://www.addevent.com/api/v1/oe/rsvps/attendee/?token=USER-TOKEN-ID&event_id=159051&user_id=kimTo3029
Returns
{
"meta": {
"code": "200"
},
"rsvps": {
"header": {
"attending": "Attending",
"name": "Name",
"email": "Email",
"ip": "IP",
"city": "City",
"region": "Region",
"country": "Country",
"location": "Location",
"postal": "Postal",
"userid": "System Id",
"createdate": "Create date",
"modifydate": "Last save date"
},
"attendees": {
"attending": "Going",
"attending_code": "1",
"name": "Sam Smith",
"email": "sam@example.org",
"ip": "",
"city": "Rybnik",
"region": "Silesia",
"country": "PL",
"location": "",
"postal": "44-203",
"userid": "VtgTLlUv17823",
"createdate": "Oct 2nd 2018 09:26am (UTC)",
"modifydate": "Oct 2nd 2018 09:26am (UTC)"
}
}
}
Parameter
Description
token
Required
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
event_id
Required
Id of the event.
Id of the event.
user_id
Required
Id of the attendee.
Id of the attendee.
Create an RSVP attendee
Creates an attendee for an RSVP event. Returns the created attendee.
$ curl https://www.addevent.com/api/v1/oe/rsvps/attendee/create/?token=token&event_id=event_id&name=name&email=email&attending=value
$ curl https://www.addevent.com/api/v1/oe/rsvps/attendee/create/?token=USER-TOKEN-ID&event_id=159051&name=Justin&email=justin@case.co&attending=1
Returns
{
"meta": {
"code": "200"
},
"attendee": {
"attending": "going",
"attending_code": "1",
"userid": "qtJCsFbY406609",
"name": "Justin Case",
"email": "justin@case.co",
"variable": "value",
"fld-dbbar": "45938475",
"ip": "",
"city": "",
"region": "",
"country": "",
"location": "",
"postal": "",
"createdate": "Jul 19th 2024 14:47pm (UTC)",
"modifydate": "Jul 19th 2024 15:32pm (UTC)"
}
}
Parameter
Description
token
Required
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
event_id
Required
Id of the event.
Id of the event.
email
Required
Email of the attendee.
If the email is already found as an attendee for the event, the records will updated for the user.
Email of the attendee.
If the email is already found as an attendee for the event, the records will updated for the user.
name
Recommended
Name of the attendee.
Name of the attendee.
attending
Optional
Accepts 1 (going) or 2 (maybe) or 3 (not going).
Defaults to "going" if not specified.
Accepts 1 (going) or 2 (maybe) or 3 (not going).
Defaults to "going" if not specified.
notify
Optional
Accepts active or passive
If notify is set to "active" the user will be sent a confirmation email with the event details and the organizer of the event will be sent an email according to the "notification settings" for the event.
If notify is set to "passive" no emails will be sent out.
Accepts active or passive
If notify is set to "active" the user will be sent a confirmation email with the event details and the organizer of the event will be sent an email according to the "notification settings" for the event.
If notify is set to "passive" no emails will be sent out.
additional form data
Optional
If your custom RSVP form is set up to require additional data you can pass data as POST or GET.
For instance. In a custom RSVP form we ask the user to enter "name" and "email". In addition we ask what their company is. The form field "slug" is e.g. "fld-dbbar". In order to fill in the field you can parse below example.
Example: &fld-dbbar=Microsoft
If your custom RSVP form is set up to require additional data you can pass data as POST or GET.
For instance. In a custom RSVP form we ask the user to enter "name" and "email". In addition we ask what their company is. The form field "slug" is e.g. "fld-dbbar". In order to fill in the field you can parse below example.
Example: &fld-dbbar=Microsoft
Save an RSVP attendee
Save an attendee for an RSVP event. Returns the saved attendee.
$ curl https://www.addevent.com/api/v1/oe/rsvps/attendee/save/?token=token&event_id=event_id&name=name&email=email&attending=value&userid=userid
$ curl https://www.addevent.com/api/v1/oe/rsvps/attendee/save/?token=USER-TOKEN-ID&event_id=159051&name=Justin&email=justin@case.co&attending=2&userid=qtJCsFcY406609
Returns
{
"meta": {
"code": "200"
},
"attendee": {
"attending": "maybe",
"attending_code": "2",
"userid": "qtJCsFbY406609",
"name": "Justin Case",
"email": "justin@case.co",
"variable": "value",
"fld-dbbar": "45938475",
"ip": "",
"city": "",
"region": "",
"country": "",
"location": "",
"postal": "",
"createdate": "Jul 19th 2024 14:47pm (UTC)",
"modifydate": "Jul 19th 2024 15:32pm (UTC)"
}
}
Parameter
Description
token
Required
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
event_id
Required
Id of the event.
Id of the event.
userid
Required
Id of the attendee.
Id of the attendee.
email
Required
Email of the attendee.
If the email is already found as an attendee for the event, the records will updated for the user.
Email of the attendee.
If the email is already found as an attendee for the event, the records will updated for the user.
name
Recommended
Name of the attendee.
Name of the attendee.
attending
Optional
Accepts 1 (going) or 2 (maybe) or 3 (not going).
Defaults to "going" if not specified.
Accepts 1 (going) or 2 (maybe) or 3 (not going).
Defaults to "going" if not specified.
notify
Optional
Accepts active or passive
If notify is set to "active" the user will be sent a confirmation email with the event details and the organizer of the event will be sent an email according to the "notification settings" for the event.
If notify is set to "passive" no emails will be sent out.
Accepts active or passive
If notify is set to "active" the user will be sent a confirmation email with the event details and the organizer of the event will be sent an email according to the "notification settings" for the event.
If notify is set to "passive" no emails will be sent out.
additional form data
Optional
If your custom RSVP form is set up to require additional data you can pass data as POST or GET.
For instance. In a custom RSVP form we ask the user to enter "name" and "email". In addition we ask what their company is. The form field "slug" is e.g. "fld-dbbar". In order to fill in the field you can parse below example.
Example: &fld-dbbar=Microsoft
If your custom RSVP form is set up to require additional data you can pass data as POST or GET.
For instance. In a custom RSVP form we ask the user to enter "name" and "email". In addition we ask what their company is. The form field "slug" is e.g. "fld-dbbar". In order to fill in the field you can parse below example.
Example: &fld-dbbar=Microsoft
List of time zones
Lists of all available time zones.
$ curl https://www.addevent.com/api/v1/timezones
Returns
{
"meta": {
"code": 200
},
"data": [{
"label": "Africa/Abidjan",
"offset": "00:00"
}, {
"label": "Africa/Accra",
"offset": "00:00"
}]
}