REST API Documentation
/calendar/events/{id}
Edit 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 topics).
Parameters
Name | Type | Description |
---|---|---|
Required
calendar
|
int | The ID number of the calendar the event should be created in |
Required
author
|
int | The ID number of the member creating the event (0 for guest). Ignored for requests using an OAuth Access Token for a particular member. |
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 |
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) |
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 |
anonymous
|
bool | If 1, the item will be posted anonymously. |
Exceptions
Code | Message | Description |
---|---|---|
1L296/I |
INVALID_ID |
The event ID is invalid or the authorized user does not have permission to view it |
1L296/D |
NO_CALENDAR |
The calendar ID does not exist or the authorized user does not have permission to post in it |
1L296/E |
NO_AUTHOR |
The author ID does not exist |
1L296/G |
INVALID_START |
The start date is invalid |
1L296/H |
INVALID_END |
The end date is invalid |
2L296/D |
NO_PERMISSION |
The authorized user does not have permission to edit the topic |
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 |
parentId
|
int|null | Parent Node ID |
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 |
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 |
rank
|
array of rank objects | Rank |
achievements_points
|
int | Points |
allowAdminEmails
|
bool | Whether or not this member wants to receive admin emails |
completed
|
bool | Whether or not the registration is completed |