SCH

Interact with SCH API
Join our community

Actions5

Overview

The node interacts with the SCH API to create appointments. It is designed to schedule an appointment slot by specifying its start and end times along with associating it with a particular lead. This node is useful in scenarios where automated scheduling or calendar management is required, such as booking meetings, consultations, or service slots linked to customer leads.

Practical examples:

  • Automatically creating an appointment slot when a new lead is generated.
  • Scheduling follow-up meetings for sales or support teams based on lead information.

Properties

Name Meaning
Slot Start Date The starting date and time of the appointment slot to be created.
Slot End Date The ending date and time of the appointment slot to be created.
Lead ID The unique identifier of the lead associated with this appointment. This is a required field.

Output

The node outputs JSON data representing the response from the SCH API after creating the appointment. This typically includes details about the newly created appointment such as its ID, scheduled times, and associated lead information.

If the node supports binary data output (not indicated here), it would represent any files or attachments related to the appointment, but no such indication is present in the provided code.

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 the Lead ID is correct and exists in the system.
  • Invalid date/time formats: The Slot Start Date and Slot End Date must be valid datetime values. Incorrect formats may result in request failures.
  • Authentication errors: If the API key or base URL is misconfigured, the node will fail to connect. Verify credentials and endpoint URLs.
  • API response errors: Any error returned by the SCH API (e.g., slot conflicts, invalid parameters) will be passed through. Review the API documentation for error codes and messages.

Links and References

  • SCH API Documentation (please refer to your internal or external SCH API docs for detailed info)
  • n8n Documentation on HTTP Request nodes and credential setup

Discussion