Endpoint Reference

POST Create Event

Creates an event. Events let users know what is going on at the school. You can show individual event categories on a page or use the calendar to aggregate multiple event categories in one location. Learn more about Events.

Request URL

https://{school}.myschoolapp.com/api/event/create?t={token}

Request headers

HeaderRequiredTypeDescription
Content-TypestringMedia type of the body sent to the API.

Request body

PropertyRequiredTypeDescription
TitlestringThe title of the event to be created.
StartDatedate The date the event to be created occurs. Use the following format - MM/DD/YYYY.
GroupListobject The category/calendar the event should be posted to. The groupId in the GET Events call.
JSON
{
  "StartDate": "09/09/2017",
  "Title": "Fall Gala",
  "BriefDescription": "Come celebrate our school!",
  "GroupList": [
    {
      "group_id": 7829,
      "selected": true
    }
  ],
  "RegistrationId": "5850",
  "EmailDisplayName": "John Doe",
  "SignupEmail": "jdoe@gmail.com",
  "FeatureDate": "06/08/2017"
}

Response 200

A ResponseMessage containing the created event ID.

JSON
{
  "Message": "2035101"
}