Monterosa Automation icon

Monterosa Automation

Interact with Monterosa Control API

Actions11

Event → Update Event

AI-generated

Summary

Update an existing event in a Monterosa project by modifying its attributes such as name, start mode, start/end times, duration, repeat settings, or by performing an action like starting or stopping the event.

Inputs

  • Project ID (required) — Specify the ID of the Monterosa project containing the event to update.
  • Event ID (required) — Provide the ID of the event you want to update.
  • Update Type (required) — Choose whether to update the event's attributes or perform an action (start/stop) on the event.
  • Event Name — Set a new name for the event when updating attributes.
  • Event Start Mode — Set the event start mode: 'manual' or 'clock' when updating attributes.
  • Event Start At — Specify the planned start time (timestamp) of the event when start mode is 'clock'.
  • Event End Time — Define when the event should end (used when the end mode is 'scheduled' and start mode is 'clock').
  • Duration — Set the duration of the event in minutes (used when start mode is 'manual' or end mode is 'duration').
  • End Mode — Choose how the event ends when start mode is 'clock': by duration or scheduled time.
  • Repeat — Indicate whether the event should repeat.
  • Repeat Interval (Minutes) — Set the interval in minutes for repeating the event after the previous event ends.
  • Custom Fields — Add custom key-value pairs to the event's attributes.
  • Action — Specify the action to perform on the event (start or stop) when Update Type is 'action'.

Output shape

a single JSON object representing the updated event or the result of the action performed

Returns the updated event data or confirmation of the start/stop action; fields returned depend on the Monterosa Control API's response. Errors will be raised for invalid inputs or unsuccessful requests.

Examples

Example 1: Updating event attributes

Provide Project ID, Event ID, set Update Type to 'attributes', and specify fields such as Event Name, Start Mode, Duration, etc.

Example 2: Starting an event

Provide Project ID, Event ID, set Update Type to 'action', and choose 'start' as the Action.

Discussion