Create CalendarEvent

POST

api

content

calendarevents

curl --request POST \
  --url https://spaces.nexudus.com/api/content/calendarevents \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "StartDate": "<string>",
  "EndDate": "<string>",
  "Repeats": 123,
  "WhichEventsToUpdate": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/content/calendarevents"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "StartDate": "<string>",
    "EndDate": "<string>",
    "Repeats": 123,
    "WhichEventsToUpdate": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    StartDate: '<string>',
    EndDate: '<string>',
    Repeats: 123,
    WhichEventsToUpdate: 123
  })
};

fetch('https://spaces.nexudus.com/api/content/calendarevents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A CalendarEvent represents a physical, virtual, or hybrid event published on the Members Portal. Events can be free or monetised with ticket products. Physical events can be linked to a space resource via ResourceId, which automatically blocks that resource from being booked for the event’s duration. Virtual events require the Zoom integration and support both conference calls (IncludeZoomInvite) and webinars (CreateZoomWebinarInvite). Events support recurring schedules: set RepeatEvent = true on creation and configure Repeats, RepeatEvery, RepeatUntil, and the day-of-week flags. RepeatEvent and all repeat-configuration fields (Repeats, RepeatEvery, RepeatUntil, RepeatOn*) are create-only. Once an event series is created, only WhichEventsToUpdate can be used to update or delete events in the series. New events cannot be added to an existing series. Attendance can be restricted to all customers, contacts only (OnlyForContacts), or members only (OnlyForMembers). Set Allocation to cap total attendees and enable EnableWaitList to allow overflow sign-ups.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CalendarEvent-Create role.

Enums

eCalendarEventRepeatCycle — Repeats values

Value	Name
1	Daily
2	Weekly
3	Monthly
4	Yearly
5	FirstOfMonth
6	SecondOfMonth
7	ThirdOfMonth
8	LastOfMonth
9	FourthOfMonth

eRepeatedCalendarEventUpdateAction — WhichEventsToUpdate values

Value	Name
1	UpdateThisEventOnly
2	UpdateFutureEventsOnly
3	UpdateAllEvents
4	DeleteAllEvents
5	DeleteEventsAfterThis
6	UpdateEventProducts

Request Body

Required Fields

integer

required

The location this event belongs to.

string

required

Event name.

string

required

Event start date and time (UTC).

string

required

Event end date and time (UTC).

integer

required

Recurrence pattern for the event series.

integer

required

Which events in the recurring series to update (update only).

Optional Fields

string

Full name of the event host or presenter.

string

Brief summary shown under the event name on the Members Portal.

string

Full event description visible when a customer opens the event on the Members Portal.

string

Additional notes included in ticket confirmation emails.

boolean

Allow customers to join a waiting list when the event is at full capacity.

boolean

Request the buyer’s postal address during ticket checkout.

boolean

Display the attendee list on the Members Portal event page.

string

Venue or room name displayed on the event page.

string

Street address of the event venue.

integer

Resource linked to this event; automatically blocked from bookings for the event’s duration.

integer

Maximum number of attendees; leave empty for unlimited.

integer[]

Categories assigned to this event.

string

Date and time the event becomes visible on the Members Portal (UTC).

boolean

Display this event in the home page banner on the Members Portal.

boolean

Display this event on the Members Portal home page.

boolean

Allow customers to post comments on the event.

boolean

Attach a Zoom conference call link to this event.

boolean

Create a Zoom webinar instead of a regular conference call.

string

Comma-separated email addresses of alternative Zoom hosts who can start the meeting.

string

Raw Zoom meeting data returned after the Zoom event is created.

string

Zoom meeting or webinar ID.

boolean

Restrict event attendance to contacts only.

boolean

Restrict event attendance to members only.

string

URL of an image to upload as the small event image.

boolean

Remove the current small event image.

string

URL of an image to upload as the large event image.

boolean

Remove the current large event image.

string

URL of an external website related to this event.

string

URL of a Facebook event or page for this event.

string

URL of an external ticketing page for this event.

string

Unique identifier shared by all occurrences in a repeat series.

boolean

Create this event as a recurring series (create only).

integer

Number of cycles between occurrences (e.g. 2 with Weekly means every two weeks).

string

Date the recurring series ends (create only).

boolean

Include Mondays in the recurring schedule.

boolean

Include Tuesdays in the recurring schedule.

boolean

Include Wednesdays in the recurring schedule.

boolean

Include Thursdays in the recurring schedule.

boolean

Include Fridays in the recurring schedule.

boolean

Include Saturdays in the recurring schedule.

boolean

Include Sundays in the recurring schedule.

string

Event start date and time in the location’s local timezone.

string

Event end date and time in the location’s local timezone.

string

Publish date and time in the location’s local timezone.

string

Background job ID for the scheduled post-event notification email.

boolean

Send a follow-up notification email to attendees after the event ends.

string

Custom message body for the post-event notification email.

boolean

Send a reminder notification email to attendees before the event starts.

boolean

A form is linked to this event that attendees are asked to complete.

boolean

Send the linked event form to attendees by email.

integer

ID of the form page linked to this event.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/content/calendarevents" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "StartDate": "2025-01-15T10:30:00Z",
    "EndDate": "2025-01-15T10:30:00Z",
    "Repeats": 0,
    "WhichEventsToUpdate": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/content/calendarevents',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      StartDate: '2025-01-15T10:30:00Z',
      EndDate: '2025-01-15T10:30:00Z',
      Repeats: 0,
      WhichEventsToUpdate: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/content/calendarevents',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'StartDate': '2025-01-15T10:30:00Z',
        'EndDate': '2025-01-15T10:30:00Z',
        'Repeats': 0,
        'WhichEventsToUpdate': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the calendarevent was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CalendarEvent was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Update CalendarEventUpdate an existing CalendarEvent record.

Create CalendarEvent

curl --request POST \
  --url https://spaces.nexudus.com/api/content/calendarevents \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "StartDate": "<string>",
  "EndDate": "<string>",
  "Repeats": 123,
  "WhichEventsToUpdate": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/content/calendarevents"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "StartDate": "<string>",
    "EndDate": "<string>",
    "Repeats": 123,
    "WhichEventsToUpdate": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    StartDate: '<string>',
    EndDate: '<string>',
    Repeats: 123,
    WhichEventsToUpdate: 123
  })
};

fetch('https://spaces.nexudus.com/api/content/calendarevents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400