Remove Participant
Node Description
This can be used to remove a participant from an upcoming appointment.
Authentication
The 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.
Remove Participant by Appointment ID and Participant ID
This method can be used to remove a participant from the appointment if the alphanumeric appointment ID and participant ID are known.
eg. appointment ID: “6064541912511b001cb77e49”
participant ID: “6664441912511b001cb77eee”
Method Name: Remove Participant by Appointment ID and Participant 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” Participant Id Unique alpha-numeric ID for the participant for this appointment Eg. “6664441912511b001cb77eee” | 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 removed participant Failure Error in removing participant |
Remove Participant by External Reference ID and Participant ID
This method can be used to remove a participant from the appointment if the alphanumeric appointment ID and participant ID are known.
eg. External Reference Id: “6064541912511b001cb77e49”
Participant Id: “6664441912511b001cb77eee”
Method Name: Remove Participant by External Reference ID and Participant 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" External Reference Id Unique reference id for the appointment tracked in the client’s system such as CRM or PAS Eg-“6064541912511b001cb77e49” Participant Id * Unique alpha-numeric ID for the participant for this appointment Eg. “6664441912511b001cb77eee” | 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 removed participant Failure Error in removing participant |
Remove Participant by Appointment ID and Customer ID
This method can be used to remove a participant from the appointment if the alphanumeric appointment ID and customer ID are known.
eg. appointment ID: “6064541912511b001cb77e49”
customer ID: “abc_1234”
Method Name: Remove Participant by Appointment ID and Customer 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” Customer Id Unique ID for the participant Eg. “abc_123” | response_body HTTP response body of the request sent to IMIASSISTAPIs Response_status_code HTTP response status code of the request sent to IMIASSIST APIs | Success Successfully removed participant Failure Error in removing participant |
Remove Participant by External Reference ID and Customer ID
This method can be used to remove a participant from the appointment if the Unique reference Id for the appointment as per the client’s system such as CRM, PAS etc and customer ID are known.
eg. External Reference ID: “APT_1001”
Customer ID: “abc_1234”
Method Name: Remove Participant by External Reference ID and Customer 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" External Reference Id Unique reference Id for the appointment as per the client’s system such as CRM or PAS Eg-“6064541912511b001cb77e49” Customer Id Unique ID for the participant Eg. “abc_123” | 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 removed participant Failure Error in removing participant |
Remove Participant by Appointment ID and Phone
This method can be used to remove a participant from the appointment if the alphanumeric appointment ID and participant’s phone number are known.
eg. appointment ID: “6064541912511b001cb77e49”
phone: “+441234567890”
Method Name: Remove Participant by Appointment ID and Phone
| 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” Phone Phone number of the participant Eg. “+441234567890” | 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 removed participant Failure Error in removing participant |
Remove Participant by External Reference ID and Phone
This method can be used to remove a participant from the appointment if the Unique reference Id for the appointment as per the client’s system such as CRM, PAS etc and Phone are known.
eg. External Reference ID: “APT_1001”
phone: “+441234567890”
Method Name: Remove Participant by External Reference ID and Phone
| 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" External Reference Id Unique reference ID of the appointment in the client’s system such as CRM or PAS Eg-“6064541912511b001cb77e49” Phone Phone number of the participant Eg. “+441234567890” | 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 removed participant Failure Error in removing participant |
Remove Participant by Appointment ID and Email
This method can be used to remove a participant from the appointment if the alphanumeric appointment ID and participant’s email are known.
eg. appointment ID: “6064541912511b001cb77e49”
email: “[email protected]”
Method Name: Remove Participant by Appointment ID and Email
| 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” Email ID of the participant Eg. “[email protected]” | 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 removed participant Failure Error in removing participant |
Remove Participant by External Reference ID and Email
This method can be used to remove a participant from the appointment if the Unique reference Id for the appointment as per the client’s system such as CRM, PAS etc and Email are known.
eg. External Reference ID: “APT_1001”
email: [email protected]
Method Name: Remove Participant by External Reference ID and Email
| 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" External Reference Id Unique reference ID of the appointment in the client’s system such as CRM or PAS Eg-“6064541912511b001cb77e49” Email ID of the participant Eg. “[email protected]” | 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 removed participant Failure Error in removing participant |
Remove Participant by Appointment ID, Phone and Email
This method can be used to remove a participant from the appointment if the alphanumeric appointment ID and participant’s phone number and email are known.
eg. appointment ID: “6064541912511b001cb77e49”
phone:”+441234567890”
email: “[email protected]”
Method Name: Remove Participant by Appointment ID, Phone and Email
| 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” Email ID of the participant Eg. [email protected] Phone * Phone number of the participant in E.164 format Eg>”+447234567890” | 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 removed participant Failure Error in removing participant |
Remove Participant by External Reference ID, Phone and Email
This method can be used to remove a participant from the appointment if the Unique reference Id for the appointment as per the client’s system such as CRM, PAS etc and Participant’s phone number and Email are known.
eg. External Reference ID: “APT_1001”
phone:”+441234567890”
email: “[email protected]”
Method Name: Remove Participant by External Reference ID, Phone and Email
| 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" External Reference Id Unique reference ID of the appointment in the client’s system such as CRM or PAS Eg-“6064541912511b001cb77e49” Email ID of the participant Eg. [email protected] Phone * Phone number of the participant in E.164 format Eg>”+447234567890” | 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 removed participant Failure Error in removing participant |
Updated 5 months ago