Add multiple events in batch

Creates multiple events in a single request for better performance.

What this endpoint does:

  • Creates multiple events efficiently with optimized database queries
  • Batch processes classroom creation (creates missing classrooms only once)
  • Associates students and professors with events in bulk
  • Sends notifications for updated events within 14 days in batches

Performance optimizations:

  • Classroom caching: Reuses classroom lookups across multiple events
  • Smart notifications: Groups notifications efficiently for updated events
  • Rate limiting: This endpoint has enhanced rate limiting due to its resource intensity

Best practices:

  • Use this endpoint when creating 5+ events to get better performance
  • Group events with similar classrooms together for better caching
  • Consider splitting very large batches (>1000 events) into smaller chunks
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
events
array of objects
required
events*
string
required

Event title (required)

string

Detailed description of the event (optional)

string
required

Event start date and time (required, format: ISO 8601)

string
required

Event end date and time (required, format: ISO 8601)

events[professors]
array of strings
events[professors]
events[students]
array of strings
events[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

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