POST residentapi/events

Create an event

Request Information

URI Parameters

None.

Body Parameters

EventCreate
NameDescriptionTypeAdditional information
PropertyId

PropertyID. Property that the event belongs to. SEE /residentapi/properties/{propertyId}

integer

Required

CommitteeId

CommitteeID. Committee that the event belongs to. Cannot be associated to a Connect Committee. SEE /residentapi/propertycommittees (not yet implemented)

integer

None.

CategoryId

CategoryID. Category that the event belongs to. Ex. "Games", "Shopping", etc. SEE /residentapi/eventcategories

integer

None.

SubCategoryId

SubCategoryID. SubCategory that the event belongs to. SEE /residentapi/eventcategories/{eventcategoryId}/eventsubcategories

integer

None.

Title

Title. Title or subject of the event

string

Required

Description

Description. Description of the event

string

Required

Location

Location. Location of the event

string

None.

DateStart

DateStart. Start Date and time of the event

date

Required

DateEnd

DateEnd. End Date and time of the event

date

Required

Fee

Fee. Event fee

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "propertyId": 1,
  "committeeId": 1,
  "categoryId": 1,
  "subCategoryId": 1,
  "title": "sample string 2",
  "description": "sample string 3",
  "location": "sample string 4",
  "dateStart": "2025-12-24T09:11:13.6316236-05:00",
  "dateEnd": "2025-12-24T09:11:13.6316236-05:00",
  "fee": 1.0
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Event
NameDescriptionTypeAdditional information
EventId

EventId. Uniqueidentifier for the event

integer

None.

PropertyId

PropertyID. Property that the event belongs to. SEE /residentapi/properties/{propertyId}

integer

None.

CommitteeId

CommitteeID. Committee that the event belongs to. Cannot be associated to a Connect Committee. SEE /residentapi/propertycommittees (not yet implemented)

integer

None.

CategoryId

CategoryID. Category that the event belongs to. Ex. "Games", "Shopping", etc. SEE /residentapi/eventcategories

integer

None.

SubCategoryId

SubCategoryID. SubCategory that the event belongs to. SEE /residentapi/eventcategories/{eventcategoryId}/eventsubcategories

integer

None.

Title

Title. Title or subject of the event

string

None.

Description

Description. Description of the event

string

None.

Location

Location. Location of the event

string

None.

DateStart

DateStart. Start Date and time of the event

date

None.

DateEnd

DateEnd. End Date and time of the event

date

None.

HyperlinkLabel

HyperlinkLabel

string

None.

HyperlinkUrl

HyperlinkUrl

string

None.

Fee

Fee. Event fee

decimal number

None.

IsCancelled

IsCancelled. Has the event been cancelled or not

boolean

None.

Calendar

Calendar. Calendars from connect (Ex. Community, Board, Committees, etc.) and the one from CWS called "CWS Calendar"

EventCalendar

None.

IsCwsEvent

IsCwsEvent. If this value is "false" then this event belongs to connect

boolean

None.

Photos

Photos. Photos for the event

Collection of EventPhoto

None.

Attachments

Collection of EventAttachment

None.

Locations

Collection of EventLocation

None.

Response Formats

application/json, text/json

Sample:
{
  "eventId": 1,
  "propertyId": 2,
  "committeeId": 1,
  "categoryId": 1,
  "subCategoryId": 1,
  "title": "sample string 3",
  "description": "sample string 4",
  "location": "sample string 5",
  "dateStart": "2025-12-24T09:11:13.6316236-05:00",
  "dateEnd": "2025-12-24T09:11:13.6316236-05:00",
  "hyperlinkLabel": "sample string 6",
  "hyperlinkUrl": "sample string 7",
  "fee": 1.0,
  "isCancelled": true,
  "calendar": {
    "calendarId": 1,
    "name": "sample string 2"
  },
  "isCwsEvent": true,
  "photos": [
    {
      "photoId": 1,
      "eventId": 2,
      "fileUrl": "sample string 3",
      "isDefault": true
    },
    {
      "photoId": 1,
      "eventId": 2,
      "fileUrl": "sample string 3",
      "isDefault": true
    }
  ],
  "attachments": [
    {
      "fileName": "sample string 1",
      "fileUrl": "sample string 2"
    },
    {
      "fileName": "sample string 1",
      "fileUrl": "sample string 2"
    }
  ],
  "locations": [
    {
      "name": "sample string 1",
      "address1": "sample string 2",
      "address2": "sample string 3",
      "city": "sample string 4",
      "state": "sample string 5",
      "zip": "sample string 6",
      "country": "sample string 7"
    },
    {
      "name": "sample string 1",
      "address1": "sample string 2",
      "address2": "sample string 3",
      "city": "sample string 4",
      "state": "sample string 5",
      "zip": "sample string 6",
      "country": "sample string 7"
    }
  ]
}