Loading ...

REST API: Create Event | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Create Event
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 39

REST API: Create Event

0 
 /5
0 (0votes)
Open API Guide
POST/api/events

Create a new event on the intranet calendar. Events can include details like location, date range, recurrence settings, and attendee invitations.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
Event JSONStringYESBodyThis is JSON that represents an event object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
EventTypeIDIntegerYESBodyUnique ID to identify the event type
DescriptionStringYESBodyThe description of event. (Optional parameter from v6.0)
TitleStringYESBodyDisplay name for the event shown on the intranet calendar and in notifications.
StartDateStringYESBodyThe event start date
EndDateStringYESBodyThe event end date

Optional Parameters

ParameterTypeRequiredLocationDescription
IsPrivateStringNOBodySpecifies if the event is private
SpaceIDIntegerNOBodyUnique ID of the space under which the event is to be created
AddressStringNOBodyAddress where the event will take place
Address2StringNOBodyAdditional address information, such as suite or apartment number
CountryIDIntegerNOBodyThe unique identifier for the country where the event is taking place. The list of countries and their codes is accessible via Rest Api: Get Countries.
StateIDIntegerNOBodyThe unique identifier for the state or region where the event is taking place. The list of states and their codes can be accessed via the Rest API: Get States.
CityStringNOBodyThe city where the event will take place
ZipStringNOBodyZip code of event's address
IsBusyBooleanNOBodyIndicates whether the event is marked as busy on calendars. It’s false by default.
IsFeaturedBooleanNOBodySpecifies if the event should be marked as featured. It’s false by default.
AllowCommentsBooleanNOBodySpecifies if attendees or users can comment on the event. It’s false by default.
AllowLikesBooleanNOBodySpecifies if attendees or users can like the event. It’s false by default.
AllowRatingBooleanNOBodySpecifies if attendees or users can rate the event. It’s false by default.
MaxAttendeesStringNOBodySets a limit on the maximum number of attendees allowed for the event
WhoShouldAttendStringNOBodySpecifies what type of people should attend the event
TagsStringNOBodyA collection of tag objects associated with the event. Each tag object includes the following sub-properties: TagID and TagName.
TagIDIntegerNOBodyThe unique identifier for the tag. Used within "Tags".
TagNameStringNOBodyThe name of the tag. Used within "Tags".
KeywordsStringNOBodyA string of tag names for categorizing the event
OrganizationStringNOBodyOrganization of creator of event
WebsiteStringNOBodyWebsite of creator of event
TelephoneStringNOBodyTelephone number of the event author
VenueNameStringNOBodyName of the event venue
IsAllDayStringNOBodyIndicates whether the event is scheduled to last the entire day
NewUsersStringNOBodyA collection of user objects to add attendees to an event. Each user object includes the following sub-properties: IsCommunityUser, UserID, AttendanceType.
IsCommunityUserBooleanNOBodySpecifies if the user is registered on the site;  set to true for registered users, false for unregistered users
UserIDIntegerNOBodyThe ID of the user you are adding to the event
AttendanceTypeIntegerNOBodyDefines the user's attendance status: 1: Attending 2: Maybe attending 3: Not attending
IsRepeatBooleanNOBodySpecifies if the event is to be repeated.  Default: false.
IsOnlineBooleanNOBodySpecifies if the event is online. Default: false.
FrequencyIntegerNOBodyDefines the frequency of the recurring event. Possible values: 0: None (default) 1: Daily 2: Weekly 4: Monthly 8: Quarterly 16: Yearly 32: Every weekday (Monday to Friday) 64: Every Monday, Wednesday, and Friday 128: Every Tuesday and Thursday.
DayIntervalStringNOBodyDefines the gap in days between each occurrence of the event when it is set to repeat daily. E.g., every day, every 2 days, every 3 days, .... , every n days. For instance, setting it to 3 will cause the event to occur every 3 days. Default: 1.
WeeklyIntervalIntegerNOBodySpecifies the number of weeks between each occurrence when the event is set to repeat weekly. For example, setting it to 1 will cause the event to occur every week, while setting it to 2 means it will repeat every 2 weeks, 3 it will repeat every 3 weeks, and so on. Default: 1.
MonthIntervalIntegerNOBodySpecifies the number of months between each event occurrence, when the event is set to  repeat monthly. E.g., every month, every 2 months, every 3 months, .... , every n months. Setting it to 2 means the event repeats every 2 months. Default: 1.
YearIntervalIntegerNOBodySpecifies the number of years between each event occurrence, when the event is set to repeat yearly. E.g., every year, every 2 years, every 3 years, .... , every n years. Default: 1.
MonthRepeatByStringNOBodySpecifies how the event should repeat on a monthly basis, with two values: 1: The event repeats on the same date each month. For example, if you schedule the event for the 10th of January, it will repeat on the 10th of every month (e.g., February 10th, March 10th, etc.). 2: The event repeats on the same day of the week in the month. For example, if the event is scheduled on the second Tuesday of January, it will repeat on the second Tuesday of every month (e.g., the second Tuesday in February, the second Tuesday in March, etc.). Default: 1.
DaysOfWeekIntegerNOBodySpecifies the days of the week on which the event occurs. The days are represented as: 1: Sunday 2: Monday 4: Tuesday 8: Wednesday 16: Thursday 32: Friday 64: Saturday You can add the numbers together to represent multiple days. For example, if you want to run the event on Monday and Tuesday, you add 2 (Monday) and 4 (Tuesday), giving you 6. Default: The event's start date. For example, if the event's start date is on a Tuesday, the default DaysOfWeek would be 4 (representing Tuesday).
DayOfMonthStringNOBodySpecifies a particular day of the month for events with a 'Monthly' frequency.  E.g., 1st day of every month, 10th day of every 2 months, etc. Default: Day of month of the start date.
RepeatEndTypeIntegerNOBodyDefines how the recurring event ends. Possible values: 1: Never ends 2: Ends after a specific number of occurrences 3: Ends on a specific date (specified by EndDate)
EndAfterOccurencesStringNOBodyInteger. Specifies how many times a recurring event will take place before the repetition stops.
RepeatEndDateISOStringNOBodySpecifies the exact date and time the recurring event will stop. ISO format (YYYY-MM-DDTHH:mm:ss) date, in time zone of user submitting event.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/events

Request Body

{
  "EventTypeID": 552,
  "Description": "Join us for a serene evening under the stars with Harmony in the Park, a classical music concert featuring renowned musicians performing timeless pieces from composers like Mozart, Beethoven, and Tchaikovsky. This enchanting event will transport you to a world of elegance and harmony, providing a perfect escape into the beauty of classical music.",
  "Title": "Harmony in the Park: An Evening of Classical Music",
  "StartDate": "2026-09-01T19:30:00",
  "EndDate": "2026-09-01T22:00:00",
  "SpaceID": 715,
  "WhoShouldAttend": "Anyone interested in classical music",
  "Address": "Central Park",
  "City": "NYC",
  "CountryID": 617
}

Success Response

{
  "IsError": false,
  "ResponseMessage": "ToBePublished",
  "ResponseData": {
    "CanBeViewed": true,
    "CanBeEdited": true,
    "CanBeDeleted": true,
    "iCalUID": "2d0c6f0e-0f76-4c81-9808-839863de2f11-0000-8edb7988-5c25-444d-a4f2-03411f05026b@communifire-intranet",
    "IsBusy": false,
    "NewUsers": [],
    "IsShared": false,
    "CanInviteOthers": false,
    "RemovedResources": [],
    "AllowComments": false,
    "AllowLikes": false,
    "AllowRating": false,
    "EventID": 1677,
    "AlbumID": 0,
    "IsPrivate": false,
    "IsScheduled": false,
    "IsEvent": true,
    "IsClassPeriod": false,
    "MediaServerID": 90,
    "CommentCount": 0,
    "EventTypeID": 871,
    "Title": "Harmony in the Park: An Evening of Classical Music bcf9",
    "WorkFlowID": 0,
    "CurrentWorkFlowStepID": 0,
    "SpaceName": "API Validate Sandbox",
    "Description": "Join us for a serene evening under the stars with Harmony in the Park, a classical music concert featuring renowned musicians performing timeless pieces from composers like Mozart, Beethoven, and Tchaikovsky. This enchanting event will transport you to a world of elegance and harmony, providing a...",
    "StartDate": "2026-09-01T23:30:00Z",
    "EndDate": "2026-09-02T02:00:00Z",
    "SpaceID": 313,
    "Views": 0,
    "IsFeatured": false,
    "IsPrivateSpace": false,
    "IsPublishedFromDraftMode": false,
    "Address": "Central Park",
    "CountryID": 1,
    "EventStatusID": 1,
    "CreatedOnDate": "2026-09-05T05:50:37.6889987Z",
    "WhoShouldAttend": "Anyone interested in classical music",
    "City": "NYC",
    "AttendanceID": 0,
    "UserID": 630,
    "IsOnline": false,
    "MetroID": 0,
    "StateID": 0,
    "UpdatedByUserID": 630,
    "AttendeeCount": 0,
    "MayBeAttendeeCount": 0,
    "Rating": 0.0,
    "EventBookedByUserID": 0,
    "IsAllDay": false,
    "MaxAttendees": 0,
    "FrequencyChoice": 0,
    "Frequency": 0,
    "DaysOfWeek": 0,
    "IsRepeat": false,
    "QuarterInterval": 0,
    "QuarterlyInterval": 0,
    "MonthlyInterval": 0,
    "WeeklyInterval": 0,
    "DaysOfMonth": 0,
    "IsSundaySelected": false,
    "IsMondaySelected": false,
    "IsTuesdaySelected": false,
    "IsWednesdaySelected": false,
    "IsThursdaySelected": false,
    "IsFridaySelected": false,
    "IsSaturdaySelected": false,
    "IsFirstWeekOfMonthSelected": false,
    "IsSecondWeekOfMonthSelected": false,
    "IsThirdWeekOfMonthSelected": false,
    "IsFourthWeekOfMonthSelected": false,
    "IsLastWeekOfMonthSelected": false,
    "FrequencyTypeOption": 0,
    "QuarterlyOptions": 0,
    "QuarterlyIntervalOptions": 0,
    "MonthlyIntervalOptions": 0,
    "WeeklyIntervalOptions": 0,
    "DaysOfWeekOptions": 0,
    "RangeStartMonth": 0,
    "RangeEndMonth": 0,
    "RepeatStartDate": "2026-09-01T23:30:00Z",
    "MonthRepeatBy": 0,
    "EndAfterOccurences": 0,
    "DayInterval": 0,
    "MonthInterval": 0,
    "DayOfMonth": 0,
    "YearInterval": 0,
    "RepeatEndType": 0,
    "StartDateWithRespectToUser": "0001-01-01T00:00:00",
    "EndDateWithRespectToUser": "0001-01-01T00:00:00",
    "RepeatStartDateWithRespectToUser": "0001-01-01T00:00:00",
    "RepeatEndDateWithRespectToUser": "0001-01-01T00:00:00",
    "SeriesEventID": 0,
    "InstanceExceptions": 0,
    "InstanceChanges": 0,
    "TimezoneOffset": -5.0,
    "TimeZoneID": "Eastern Standard Time",
    "IsDayLightSaving": true,
    "InstanceNumber": 0,
    "TenantID": 1
  }
}
`n

Error Response

{
  "IsError": true,
  "ResponseMessage": "All required parameters are not provided."
}

Error Handling

Status CodeLikely CauseNext Action
200 with IsErrorTitle, StartDate, EndDate, or an existing EventTypeID is missing, or StartDate is after EndDate (All required parameters are not provided); or calendar sync with Outlook is enabled without a default Outlook account (the message says so); ResponseMessage says which.Read IsError on every response; verify the request against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages