SCH

Interact with SCH API
Join our community

Actions5

Overview

The node interacts with the SCH API to update appointment details. Specifically, it allows updating an existing appointment's start and end date/time along with associating it with a specific lead ID. This is useful in scenarios where appointment schedules need to be modified programmatically, such as rescheduling meetings or correcting appointment times in an automated workflow.

Practical examples include:

  • Automatically adjusting appointment times based on user input or external calendar changes.
  • Linking appointments to different leads dynamically during a sales or customer management process.

Properties

Name Meaning
Slot Start Date The new start date and time of the appointment slot to be updated.
Slot End Date The new end date and time of the appointment slot to be updated.
Lead ID The identifier of the lead associated with the appointment. This is required for update.

Output

The node outputs JSON data representing the response from the SCH API after attempting to update the appointment. This typically includes confirmation of the updated appointment details or error information if the update failed.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the SCH API.
  • The base URL for the SCH API must be configured in the node credentials.
  • The node sends requests with Accept: application/json and Content-Type: application/json headers.

Troubleshooting

  • Missing or invalid Lead ID: Since Lead ID is required, omitting it or providing an invalid value will likely cause errors. Ensure a valid numeric Lead ID is provided.
  • Invalid date formats: The Slot Start Date and Slot End Date must be valid datetime values. Incorrect formatting may result in API rejection.
  • Authentication errors: If the API key or base URL is misconfigured, the node will fail to authenticate. Verify credentials and endpoint settings.
  • API errors: The SCH API might return errors if the appointment ID does not exist or if the update violates business rules. Check the returned JSON error messages for details.

Links and References

  • Refer to the official SCH API documentation for detailed information on appointment update endpoints and required parameters.
  • n8n documentation on creating and configuring HTTP request nodes for API interaction.

Discussion