Update an existing event

Updates an existing event with new information.

What this endpoint does:

  • Updates only the fields you specify (partial update)
  • Creates new classrooms if they don't exist
  • Intelligently manages student and professor associations
  • Sends notifications to students for upcoming events (within 14 days)
  • Handles errors gracefully if some student/professor IDs are invalid

Smart participant management:

  • Replacement logic: When you provide a students or professors array, it completely replaces the existing list
  • Adding participants: The system automatically determines who to add
  • Removing participants: The system automatically determines who to remove
  • Empty arrays: Send [] to remove all students or professors from the event

Automatic notifications: Students receive push notifications when dates, times, or locations change for upcoming events.

Partial updates: Only include the fields you want to change. Omitted fields remain unchanged.

Path Params
string
required

Event identifier in the URL (use internal Edusign event ID)

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

New event title (optional - only include if changing)

string

New start date and time (optional, format: ISO 8601)

string

New end date and time (optional, format: ISO 8601)

string

New event description (optional - set to null to remove)

professors
array of strings
professors
students
array of strings
students
string

New classroom or location name (will be created if it doesn't exist)

string

New external API identifier

string

New source system or category for the external API

string

New display color 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