API: One-time Events

The AddEvent API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.
All API access is over HTTPS. All data is sent and received as JSON, including errors.

Data
Please URL encode all parameter values. Your API token is: .

JOB List one-time events

Returns a list of one-time events. The events are sorted by recently created.

$ curl https://www.addevent.com/api/v1/oe/events/list/?token=token

Example with data

https://www.addevent.com/api/v1/oe/events/list/?token=

Returns

{
	"meta": {
		"code": "200"
	},
	"calendar": {
		"events_count": 33
	},
	"events": [{
		"id": "125163",
		"title": "Cookie Fridays",
		"eventname": "Cookie Fridays",
		"description": "The oven is hot and our cookies are ready to be served :-)\r\n\r\nInclude a link to direct users to: http:\/\/www.example.com\/cookies\r\n\r\nToday's special is Cinnamon Spice stuffed with White Chocolate Chip.\r\n\r\nStop by before 12pm and get yours! Buy one, get one free to all followers.",
		"location": "1416 Valencia St, San Francisco, CA 94110",
		"organizer": "",
		"organizer_email": "",
		"date_start": "04\/21\/2017",
		"date_start_time": "15:00:00",
		"date_start_ampm": "PM",
		"date_start_unix": 1492786800,
		"date_end": "04\/21\/2017",
		"date_end_time": "16:00:00",
		"date_end_ampm": "PM",
		"date_end_unix": 1492790400,
		"all_day_event": "false",
		"date_format": "MM\/DD\/YYYY",
		"timezone": "America\/Los_Angeles",
		"reminder": "15",
		"date_create": 1473984345,
		"date_modified": 1473984345,
		"updated_times": "0"
	}, {
		"id": "125162",
		"title": "Cookie Fridays",
		"eventname": "Cookie Fridays",
		"description": "The oven is hot and our cookies are ready to be served :-)\r\n\r\nInclude a link to direct users to: http:\/\/www.example.com\/cookies\r\n\r\nToday's special is Cinnamon Spice stuffed with White Chocolate Chip.\r\n\r\nStop by before 12pm and get yours! Buy one, get one free to all followers.",
		"location": "1416 Valencia St, San Francisco, CA 94110",
		"organizer": "",
		"organizer_email": "",
		"date_start": "04\/14\/2017",
		"date_start_time": "15:00:00",
		"date_start_ampm": "PM",
		"date_start_unix": 1492182000,
		"date_end": "04\/14\/2017",
		"date_end_time": "16:00:00",
		"date_end_ampm": "PM",
		"date_end_unix": 1492185600,
		"all_day_event": "false",
		"date_format": "MM\/DD\/YYYY",
		"timezone": "America\/Los_Angeles",
		"reminder": "15",
		"date_create": 1473984345,
		"date_modified": 1473984345,
		"updated_times": "0"
	}],
	"paging": {
		"previous": "",
		"next": "https:\/\/www.addevent.com\/api\/v1\/events\/list\/?token=&page=2"
	}
}

Parameters

Parameter
Description
token
Mandatory   Account token.

JOB Create one-time event

Creates an one-time event. Returns the event created.

$ curl https://www.addevent.com/api/v1/oe/events/create/?token=token&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

Example with data

https://www.addevent.com/api/v1/oe/events/create/?token=&title=Title+of+the+event&eventname=Name+of+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/Los_Angeles&reminder=60&start_date=01%2F31%2F2017+09%3A00&end_date=01%2F31%2F201711%3A00&all_day_event=false

Returns

{
	"meta": {
		"code": "200"
	},
	"event": {
		"id": 159051,
		"uniquekey": "GV160458",
		"title": "Title of the event",
		"eventname": "Name of event",
		"description": "Description of the event",
		"location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
		"organizer": "Thomas Scott",
		"organizer_email": "thomas@example.com",
		"date_start": "01\/31\/2017",
		"date_start_time": "09:00:00",
		"date_start_ampm": "AM",
		"date_end": "01\/31\/2017",
		"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",
		"updated_times": "0",
		"date_create": 1479434024,
		"date_modified": 1479434024
	}
}

Parameters

Parameter
Description
token
Mandatory   Account token.
title
Mandatory   Title of the event
eventname
Name of the event
description
Description of the event. Use \n for line breaks.
location
Location of the event, e.g. "1600 Amphitheatre Pkwy, Mountain View, CA 94043".
organizer
Organizer of the event, e.g. "Thomas Scott".
organizer_email
Organizer's email, e.g. "thomas@example.com"
timezone
Mandatory   Time zone of the event, e.g. "America/Los_Angeles". View "Timezones" for all time zones available. Uses "America/Los_Angeles" time zone if not defined.
reminder
Set an event reminder. Value is in minutes, e.g. "5" or "10" or "60" or "120" minutes.
start_date
Mandatory   Start date of the event. Accepts numeric dates, e.g. "01/31/2017 09:00" or "01/31/2017 09:00 AM". Accepted format of date: "MM/DD/YYYY HH:MM".
end_date
End date of the event. Accepts numeric dates, e.g. "01/31/2017 11:00" or "01/31/2017 11:00 AM". Accepted format of date: "MM/DD/YYYY HH:MM". If end_date isn't defined, end_date becomes start_date plus 1 hour.
all_day_event
All day event. Defaults to "false". Accepts "true" or "false".

JOB Save an one-time event

Save an one-time event. 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

Example with data

https://www.addevent.com/api/v1/oe/events/save/?token=&event_id=159051&title=Title+of+the+event&eventname=Name+of+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/Los_Angeles&reminder=60&start_date=01%2F31%2F2017+09%3A00&end_date=01%2F31%2F201711%3A00&all_day_event=false

Returns

{
	"meta": {
		"code": "200"
	},
	"event": {
		"id": 159051,
		"uniquekey": "GV160458",
		"title": "Title of the event",
		"eventname": "Name of event",
		"description": "Description of the event",
		"location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
		"organizer": "Thomas Scott",
		"organizer_email": "thomas@example.com",
		"date_start": "01\/31\/2017",
		"date_start_time": "09:00:00",
		"date_start_ampm": "AM",
		"date_end": "01\/31\/2017",
		"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",
		"updated_times": "1",
		"date_create": 1479434024,
		"date_modified": 1479434024
	}
}

Parameters

Parameter
Description
token
Mandatory   Account token.
event_id
Mandatory   Id of the event.
title
Mandatory   Title of the event
eventname
Name of the event
description
Description of the event. Use \n for line breaks.
location
Location of the event, e.g. "1600 Amphitheatre Pkwy, Mountain View, CA 94043".
organizer
Organizer of the event, e.g. "Thomas Scott".
organizer_email
Organizer's email, e.g. "thomas@example.com"
timezone
Mandatory   Time zone of the event, e.g. "America/Los_Angeles". View "Timezones" for all time zones available. Uses "America/Los_Angeles" time zone if not defined.
reminder
Set an event reminder. Value is in minutes, e.g. "5" or "10" or "60" or "120" minutes.
start_date
Mandatory   Start date of the event. Accepts numeric dates, e.g. "01/31/2017 09:00" or "01/31/2017 09:00 AM". Accepted format of date: "MM/DD/YYYY HH:MM".
end_date
End date of the event. Accepts numeric dates, e.g. "01/31/2017 11:00" or "01/31/2017 11:00 AM". Accepted format of date: "MM/DD/YYYY HH:MM". If end_date isn't defined, end_date becomes start_date plus 1 hour.
all_day_event
All day event. Defaults to "false". Accepts "true" or "false".

JOB Delete an one-time event

Deletes an one-time event. Returns a deletion status.

$ curl https://www.addevent.com/api/v1/oe/events/delete/?token=token&event_id=event_id

Example with data

https://www.addevent.com/api/v1/oe/events/delete/?token=&event_id=159051

Returns

{
	"meta": {
		"code": "200"
	},
	"event": {
		"id": "159051",
		"status": "deleted"
	}
}

Parameters

Parameter
Description
token
Mandatory   Account token.
event_id
Mandatory   Id of the event.

JOB List of time zones

Lists 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"
	},
	{
		etc.
	}]
}