Add a new event

Creates a new event in your school's system.

What this endpoint does:

  • Creates a new event with the provided information
  • Creates classrooms if they don't exist in the system
  • Associates students and professors with the event
  • Sends push notifications to students if the event already exists, is updated and is within 14 days
  • Handles errors gracefully if some students or professors aren't found

Automatic features:

  • Classroom creation: If you specify a classroom name that doesn't exist, it will be automatically created
  • Smart notifications: Students receive push notifications for updated events happening within the next 14 days
  • Error resilience: The event is still created even if some student/professor IDs are invalid

API ID Mode: Use this when your external system has its own user IDs that differ from Edusign's internal IDs.

Query Params
string
Defaults to false

Switch between internal IDs and external API IDs for students/professors
Important: When enabled, use external API IDs in the students and professors arrays instead of internal Edusign IDs.

Body Params
string
required

Event title (required)

string

Detailed description of the event (optional)

string
required

Event start date and time (required, format: ISO 8601, e.g., "2020-01-20T15:00:00.000Z")

string
required

Event end date and time (required, format: ISO 8601, e.g., "2020-01-20T18:00:00.000Z")

professors
array of strings
professors
students
array of strings
students
string

Classroom or location name (will be automatically created if it doesn't exist)

string
required

External API identifier for this event (required for tracking and updates)

string

Source system or category for the external API (e.g., "calendar_system")

string

Display color for the event in hex format (e.g., "#4c00ff")

Response

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json