Actions58
- Address Actions
- Agentslog Actions
- Appointment Actions
- E-Mail Actions
- Estate Actions
- File Actions
- Relation Actions
- Search Criterion Actions
- Setting Actions
- Task Actions
- Template Actions
Appointment → Update
AI-generatedOverview
This node updates an existing appointment in the onOffice system. It is useful for scenarios where you need to modify details of a scheduled appointment, such as changing the time, description, status, or linked resources. For example, you can update the appointment's start and end times, add notes, set reminders, or link related addresses and estates.
Use Case Examples
- Updating the start and end date/time of an appointment.
- Adding a note or description to an existing appointment.
- Changing the appointment status to 'completed' or 'canceled'.
- Linking related address IDs or an estate ID to the appointment.
Properties
| Name | Meaning |
|---|---|
| Appointment ID | The ID of the appointment to update, used to identify which appointment record to modify. |
| Data | A collection of fields to update on the appointment, including all-day status, description, end date/time, notes, privacy, reminder time, linked resources, start date/time, status, and type. |
| Related Address IDs | Comma-separated list of address IDs to link to the appointment. |
| Replace Address IDs | Whether to replace existing address links with the new list provided. |
| Related Estate ID | Estate ID to link to the appointment. |
Output
JSON
appointmentId- The ID of the updated appointment.status- The updated status of the appointment.start_dt- The updated start date/time of the appointment.end_dt- The updated end date/time of the appointment.description- The updated description of the appointment.note- The updated notes on the appointment.reminder- The updated reminder time before the appointment.resources- The updated list of linked resources.relatedAddressIds- The updated list of linked address IDs.relatedEstateId- The updated linked estate ID.
Dependencies
- Requires an API key credential for onOffice API authentication.
Troubleshooting
- Ensure the Appointment ID provided exists and is correct; otherwise, the update will fail.
- Verify that date/time fields are in the correct format (e.g., 'YYYY-MM-DD HH:mm:ss').
- Check that the reminder value is one of the allowed options.
- If replacing address IDs, ensure the list is correctly formatted as comma-separated values.
- API authentication errors may occur if the API key credential is missing or invalid.