Cancel Appointments

Nodes Description

This node can be used to cancel an existing appointment in IMIASSIST.

Authentication

Api Key and Token are required input variables. Get them by using the authentication node to authenticate your request. For more information, see the Authentication section.

Here’s a brief description of the methods available under this node.

Cancel by Appointment ID

This method can be used to cancel an appointment if the alphanumeric appointment ID is known. (eg. appointment ID: “6064541912511b001cb77e49”)

Method Name: Cancel by Appointment ID

Input Variable	Output Variable	Nodes Outcomes
Subdomain Name of the subdomain associated with the company Eg- "healthcarecomms" Domain Name of the domain to which the company belongs Eg- "eclinic.org.uk", “imiassist.ai” Api key API key of the company Eg-"ca4356d0-an16-01e9-7ff9-23ab6aaded3a" Token Token that will be used to authenticate the request Eg- "6be695efdd16df50d15ac8816517576 800c0b9e25d47d6ae67ca40f169bfad5e" Appointment ID * Unique alpha-numeric ID of the appointment Eg-“6064541912511b001cb77e49”	appointment_id Unique alpha-numeric ID of the appointment appointment_uid Unique friendly ID of the appointment response_body HTTP response body of the request sent to IMIASSIST APIs response_status_code HTTP response status code of the request sent to IMIASSIST APIs	Success Successfully cancelled an appointment Failure Error in cancelling an appointment

Cancel by Appointment UID

This method can be used to cancel an appointment if the UI friendly ID is known. (eg. appointment UID: “DD-45-1”)

Method Name: Cancel by Appointment UID

Input Variables	Output Variables	Nodes Outcomes
Subdomain Name of the subdomain associated with the company Eg- "healthcarecomms" Domain Name of the domain to which the company belongs Eg- "eclinic.org.uk", ”imiassist.ai” Api Key API key of the company Eg-"ca4356d0-an16-01e9-7ff9-23ab6aaded3a" Token Token that will be used to authenticate the request Eg- "6be695efdd16df50d15ac8816517576800c0b9e25d47d6ae67ca40f169bfad5e" Appointment Uid * Unique friendly ID of the appointment Eg-“DD-45-1”	appointment_id Unique alpha-numeric ID of the appointment appointment_uid Unique friendly ID of the appointment response_body HTTP response body of the request sent to IMIASSIST APIs response_status_code HTTP response status code of the request sent to IMIASSIST APIs	Success Successfully cancelled an appointment Failure Error in cancelling an appointment

Cancel by Appointment Data

This method can be used to cancel an appointment based on appointment data such as customer data, start time, team name etc.

Method Name: Cancel by Appointment Data

Input Variables	Output Variables	Nodes Outcomes
Subdomain Name of the subdomain associated with the company Eg- "healthcarecomms" Domain Name of the domain to which company belongs Eg-"eclinic.org.uk", ”imiassist.ai” Api Key API key of the company Eg-"ca4356d0-an16-01e9-7ff9-23ab6aaded3a" Token Token that will be used to authenticate the request Eg- "6be695efdd16df50d15ac8816517576 800c0b9e25d47d6ae67ca40f169bfad5e" Customer Id (Optional) Client ID of the customer Eg-"NHSID_01" Customer Phone (Optional) Phone number of the customer that will be used for the appointment Eg- "+44123456789"(phone number prefixed with +country code) Customer Email (Optional) Email of the customer that will be used for the appointment Eg- "[email protected]" Team Id (Optional) Team ID under which the appointment has to be created Eg- "5c75445d8eb2b817b465328d”" Appointment Type (Optional) Appointment type under which the appointment has to be created Eg-“testing” Start Time End of the appointment in ISO format Eg- "2021-05-09T07:00:00.000Z"	appointment_id Unique alpha-numeric ID of the appointment appointment_uid Unique friendly id of the appointment response_body HTTP response body of the request sent to IMIASSIST APIs response_status_code HTTP response status code of the request sent to IMIASSIST APIs	Success Successfully cancelled an appointment Failure Error in cancelling an appointment