Jump to content

Community

REST API Documentation

/calendar/events


Create an event

For requests using an OAuth Access Token for a particular member, any parameters the user doesn't have permission to use are ignored (for example, locked will only be honoured if the authenticated user has permission to lock events).


Parameters

Name Type Description
Required calendar int The ID number of the calendar the event should be created in
Required title string The event title
Required description string The description as HTML (e.g. "<p>This is an event.</p>"). Will be sanatized for requests using an OAuth Access Token for a particular member; will be saved unaltered for requests made using an API Key or the Client Credentials Grant Type.
Required start datetime The event start date/time
author int The ID number of the member creating the event (0 for guest). Required for requests made using an API Key or the Client Credentials Grant Type. For requests using an OAuth Access Token for a particular member, that member will always be the author
end datetime The event end date/time
recurrence string If this event recurs, the ICS recurrence definition
rsvp bool If this event accepts RSVPs
rsvpLimit int The number of RSVPs the event is limited to
location geolocation object The location where the event is taking place
prefix string Prefix tag
tags string Comma-separated list of tags (do not include prefix)
date datetime The date/time that should be used for the event/post post date. If not provided, will use the current date/time. Ignored for requests using an OAuth Access Token for a particular member.
ip_address string The IP address that should be stored for the event/post. If not provided, will use the IP address from the API request. Ignored for requests using an OAuth Access Token for a particular member.
locked int 1/0 indicating if the event should be locked
hidden int 0 = unhidden; 1 = hidden, pending moderator approval; -1 = hidden (as if hidden by a moderator)
featured int 1/0 indicating if the event should be featured

Exceptions

Code Message Description
1L296/6 NO_CALENDAR The calendar ID does not exist
1L296/7 NO_AUTHOR The author ID does not exist
1L296/8 NO_TITLE No title was supplied
1L296/9 NO_DESC No description was supplied
1L296/A INVALID_START The start date is invalid
1L296/B INVALID_END The end date is invalid
2L296/C NO_PERMISSION The authorized user does not have permission to create an event in that calendar

Response

Name Type Description
id int ID number
title string Title
calendar calendar object Calendar
start datetime Event start time
end datetime Event end time
recurrence string If this event recurs, the ICS recurrence definition
rsvp bool If this event accepts RSVPs
rsvpLimit int The number of RSVPs the event is limited to
location geolocation object The location where the event is taking place
venue venue object The venue data
author member object The member that created the event
postedDate datetime When the event was created
description string Event description
comments int Number of comments
reviews int Number of reviews
views int Number of posts
prefix string The prefix tag, if there is one
tags array of strings The tags
locked bool Event is locked
hidden bool Event is hidden
featured bool Event is featured
url string URL

calendar object

Name Type Description
id int ID number
name string Name
url string URL
class string Node class
permissions object|null Node permissions

geolocation object

Name Type Description
lat float Latitude
long float Longitude
addressLines array of strings Lines of the street address
city string City
region string State/Region
country string 2-letter country code
postalCode string ZIP/Postal Code

venue object

Name Type Description
id int ID number
title string Title
description string Description
address geolocation object The address

member object

Name Type Description
id int ID number
name string Username
title string Member title
timezone string Member timezone
formattedName string Username with group formatting
ipAddress string IP address used during registration
primaryGroup group object Primary group
secondaryGroups array of group objects Secondary groups
email string Email address
joined datetime Registration date
registrationIpAddress string IP address when registered
warningPoints int Number of active warning points
reputationPoints int Number of reputation points
photoUrl string URL to photo (which will be the site's default if they haven't set one)
photoUrlIsDefault bool Indicates if the value of photoUrl is the site's default
coverPhotoUrl string URL to profile cover photo (will be blank if there isn't one)
profileUrl string|null URL to profile
validating bool Whether or not the validating flag is set on the member account
posts int Number of content item submissions member has made
lastActivity datetime|null Last activity date on the site
lastVisit datetime|null Last distinct visit date on the site
lastPost datetime|null Latest content submission date
profileViews int Number of times member's profile has been viewed
birthday string Member birthday in MM/DD/YYYY format (or MM/DD format if no year has been supplied)
customFields array of fieldgroup objects Custom profile fields. For requests using an OAuth Access Token for a particular member, only fields the authorized user can view will be included

group object

Name Type Description
id int ID number
name string Name
formattedName string Name with formatting

fieldgroup object

Name Type Description
name string Group name
fields array of field objects Fields

field object

Name Type Description
name string Field name
value string Value
×
×
  • Create New...