Add Participant

Nodes Description

This can be used to add a participant to 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.

Add Host by Appointment ID

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

Method Name: Add Host 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	appointment_id Unique alpha-numeric ID of the appointment participant_id Unique alpha-numeric ID for the participant for this 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 API role User’s Role, “host” In This Case first_name First Name Of The Host As Registered In The Application last_name * Last Name Of The Host As Registered In The Application	Success Successfully added participant to the appointment Failure Error in adding participant

Add Host by External Reference ID

This method can be used to add Host to the appointment if the unique reference Id for the appointment as per the client’s system such as CRM, PAS etc. is known (eg. EXTERNAL REFERENCE ID: “APT1001”)

Method Name: Add Host by External Reference 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, pas etc. Eg-“apt-1001” Email Email id of the host registered in the application [email protected]	appointment_id Unique alpha-numeric id of the appointment participant_id Unique alpha-numeric id for the participant for this appointment role User’s Role, “host” In This Case first_name First name of the host as registered in the application last_name Last name of the host as registered in the application 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	Failure * Error in adding participant

Add Guest by Appointment ID

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

Method Name: Add Guest 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- "6be695efdd16df50d15ac8816517576800 C0b9e25d47d6ae67ca40f169bfad5e" Appointment Id Unique alpha-numeric id of the appointment First Name • First Name Of The Guest Eg-"Test" Last Name Last Name Of The Guest Eg-"Cust" Client Id (Optional) Unique Identifier That Can Be Used To Map The Guest Eg- "Uniqueid_01" Phone (Optional) Phone number of the guest Eg- "+44123456789"(phone number should be prefixed with +country code) Email (Optional) Email of the guest Eg- "[email protected]" Custom Attributes(Optional) Custom attributes can be used to capture additional custom data of the guest Eg-{ "age" : 10, "gender" : "female" }	appointment_id Unique alpha-numeric id of the appointment participant_id Unique alpha-numeric id for the participant for this appointment contact_id Unique id associated with the guest’s contact record role User’s role, “guest” in this case first_name First name of the guest last_name Last name of the guest 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 guest_link * One-time use appointment link for the guest	Success Successfully added participant to the appointment Failure Error in adding participant

Add Guest by External Reference ID

This method can be used to add a Guest to the appointment if the unique reference Id for the appointment as per the client’s system such as CRM, PAS etc. is known (eg. EXTERNAL REFERENCE ID: “APT-1001”)

Method Name: Add Guest by External Reference 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- "6be695efdd16df50d15ac8816517576800 C0b9e25d47d6ae67ca40f169bfad5e" External Reference Id Unique reference id for the appointment as per the client’s system such as crm, pas etc. Eg-“apt-1001” First Name First Name Of The Guest Eg-"Test" Last Name Last Name Of The Guest Eg-"Cust" Client Id (Optional) Unique Identifier That Can Be Used To Map The Guest Eg- "Uniqueid_01" Phone (Optional) Phone number of the guest Eg- "+44123456789"(phone number should be prefixed with +country code) Email (Optional) Email of the guest Eg- "[email protected]" Custom Attributes(Optional) * Custom attributes can be used to capture additional custom data of the guest Eg-{ "age" : 10, "gender" : "female" }	appointment_id Unique alpha-numeric id of the appointment participant_id Unique alpha-numeric id for the participant for this appointment contact_id Unique id associated with the guest’s contact record role User’s role, “guest” in this case first_name First name of the guest last_name Last name of the guest 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 guest_link * One-time use appointment link for the guest	Success Successfully added participant to the appointment Failure Error in adding participant