Monterosa Automation

Interact with Monterosa Control API

Overview

The "Update Element" operation in the Monterosa Automation node allows users to modify existing interactive elements within a Monterosa project. These elements can be quiz questions, polls, or other interactive content pieces used in live or recorded events. This operation supports various actions such as publishing an element, revealing answers or results, revoking, stopping, or updating the element's attributes.

Typical use cases include:

  • Updating the question text or options of a quiz element.
  • Changing the start mode or timing of an element.
  • Publishing or stopping an element during a live event.
  • Revealing answers or results for quiz-type elements.
  • Revoking an element to disable it.

For example, a user might update a quiz question's text and options before publishing it to viewers, or reveal the correct answer after participants have voted.

Properties

Name Meaning
Project ID The unique identifier of your Monterosa project where the element exists.
Localization Determines how text localization is handled: either "All Languages" (same text for all) or "English Only".
Element ID The unique identifier of the element to update or delete (e.g., a UUID string).
Action The action to perform on the element. Options include: Publish, Reveal Answer, Reveal Results, Revoke, Stop, Update Attributes.
Use Custom JSON Whether to send a custom JSON request body instead of using the form fields.
Custom JSON A raw JSON object representing the full request body for the update. Used only if "Use Custom JSON" is true.
Start Mode How the element starts: "Manual" (triggered manually) or "Timecode" (starts at a specific time offset).
Question Collection of question details including:
- Question Text
- Question Image URL
- Custom Fields (key-value pairs for additional metadata)
Options List of option objects each containing:
- Option Text
- Option Image URL
- Custom Fields (key-value pairs)
Correct Option Number indicating the correct option (used for revealing answers or trivia elements).
Correct Option Index 1-based index of the correct option, required for trivia elements when updating via form fields (not custom JSON).
Update Fields When action is "update", this collection includes fields to update:
- Duration (seconds)
- Offset (seconds, required if start mode is timecode)
- Options (list of options with text and custom fields)
- Question (text and custom fields)
- Start Mode
- Voting Settings (certification, max votes per user, reveal results mode, etc.)

Output

The node outputs a JSON object representing the response from the Monterosa Control API after performing the update operation. This typically includes the updated element data or confirmation of the performed action.

The output JSON structure corresponds to the API's response format for element updates, which may contain:

  • Element ID and type
  • Updated attributes such as question text, options, duration, start mode
  • Status of the element (published, stopped, revoked, etc.)
  • Any error messages if the operation failed

No binary data output is produced by this node.

Dependencies

  • Requires a valid API authentication token credential for the Monterosa Control API.
  • Needs the Project ID to identify the target Monterosa project.
  • Network access to Monterosa Control API endpoints.
  • Proper permissions on the API key to update elements within the specified project.

Troubleshooting

  • Invalid Project ID or Element ID: Ensure that the provided IDs are correct and exist in your Monterosa account.
  • Authentication Errors: Verify that the API token credential is valid and has not expired.
  • Incorrect JSON Structure: If using custom JSON, ensure it matches the expected API schema; malformed JSON will cause errors.
  • Missing Required Fields: For certain actions like "reveal_answer," the correct option number must be provided.
  • Start Mode Timecode Without Offset: When using "timecode" start mode, the offset field is required.
  • API Rate Limits or Network Issues: Check network connectivity and API usage limits if requests fail intermittently.

Common error messages usually indicate missing parameters, invalid IDs, or authorization failures. Reviewing the API response message helps pinpoint the issue.

Links and References

  • Monterosa Control API Documentation (general reference for element management)
  • Monterosa Automation Node README (if available in n8n community)
  • JSON Schema examples for element creation and update (referenced in the "Custom JSON" property hint)

Discussion