Contact Management
Nodes Description
This node can be used to create, update, delete contact records in IMIASSIST.
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.
Create a Contact
This method can be used to create a new contact.
Note:
Phone number, email or both phone number and email will be treated as mandatory fields as per the company settings configuration.
Method Name: Create a Contact
| 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- "6be695efdd16df50d15ac8816517576800 c0b9e25d47d6ae67ca40f169bfad5e" First Name First name of the contact Eg-"Test" Last Name Last name of the contact Eg-"Cust" Customer Id (Optional) Unique identifier that can be used to map the contact Eg- "UniqueID_01" Phone (Optional) Phone number of the contact Eg- "+44123456789"(phone number is prefixed with +country code) Email (Optional) Email of the contact Eg- "[email protected]" Custom Attributes(Optional) Custom attributes can be used to capture additional custom data of the contact Eg-{ "age" : 10, "gender" : "female" } | contact_id Unique alphanumeric ID of the contact 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 created a contact Failure Error in creating a contact |
Update a Contact by Contact ID
This method can be used to update a contact, if the long alpha-numeric contact ID is known.
Method Name: Update a Contact by Contact ID
| 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” Contact Id ID of the existing contact. This will be used in identifying the contact to be updated. Eg-“6064541912511b001cb77e49” 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" New Customer Id (Optional) New customer ID that has to be updated for the existing contact Eg-"UniqueID_02" New Phone (Optional) New phone number that has to be updated for the existing contact Eg-"+919988676543"(phone number is prefixed with +country code) New Email (Optional) New email that has to be updated for the existing contact Eg-"[email protected]" New Custom Attributes (Optional) * New custom attributes that has to be updated for the existing contact Eg-{ "age" : 10, "gender" : "female" } | contact _id Unique alphanumeric ID of the contact 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 updated a contact Failure Error in updating a contact |
Update a Contact by Customer ID
This method can be used to update a contact record if the Customer ID is known.
Customer ID is used as a unique ID for a contact. Any unique ID such as customer registration number can be stored as the Customer ID field in Webex Assist.
Method Name: Update a Contact by Customer ID
| 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” Existing Customer Id Customer ID of the existing contact. This will be used in identifying the contact to be updated Eg-“NHSID_10" 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" New Customer Id (Optional) New customer ID that has to be updated for the existing contact Eg-“NHSID_65" New Phone (Optional) New phone number that has to be updated for the existing contact Eg-"+919988676543"(phone number is prefixed with +country code) New Email (Optional) New email that has to be updated for the existing contact Eg-"[email protected]" New Custom Attributes (Optional) * New custom attributes that has to be updated for the existing contact Eg-{ "age" : 10, "gender" : "female" } | contact_id Unique alphanumeric ID of the contact 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 updated a contact Failure Error in updating a contact |
Update a Contact by Phone
This method can be used to update a contact if the phone number is known.
Method Name: Update a Contact by Phone
| 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” Existing Phone Phone number of the existing contact. This will be used in identifying the contact to be updated Eg-"+919988676543"(phone number is prefixed with +country code) Api Key API key of the company Eg-"ca4356d0-an16-01e9-7ff9-23ab6aaded3a" Token Token that will be used to authenticate the request Eg-"6be695efdd16df50d15ac881651757680 0c0b9e25d47d6ae67ca40f169bfad5e" New Customer ID (Optional) New Customer ID that has to be updated for the existing contact Eg-“NHSID_11” New Phone Number (Optional) New phone number that has to be updated for the existing contact Eg-"+91998863457"(phone number is prefixed with +country code) New email (Optional) New email that has to be updated for the existing contact Eg-"[email protected]" New Custom Attributes (Optional) * New custom attributes that have to be updated for the existing contact Eg-{ "age" : 10, "gender" : "female" } | contact_id Unique alphanumeric ID of the contact 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 updated a contact Failure Error in updating a contact |
Update a Contact by Email
This method is used to update a contact if the email ID is known.
Method Name: Update a Contact by Email
This method is used to update a contact if the email ID is known.
| 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” Existing Email Email of the existing contact. This will be used in identifying the contact to be updated Eg-"[email protected]" Api Key API key of the company Eg-"ca4356d0-an16-01e9-7ff9-23ab6aaded3a" Token Token that will be used to authenticate the request Eg-"6be695efdd16df50d15ac881651757680 0c0b9e25d47d6ae67ca40f169bfad5e" New Customer Id (Optional) New customer ID that has to be updated for the existing contact Eg-“NHSID_11” New Phone (Optional) New phone number that has to be updated for the existing contact in E.164 format. Eg- “+91998863457" (phone number is prefixed with +country code) New email (Optional) New email that has to be updated for the existing contact Eg-”[email protected]” New Custom Attributes (Optional) * New custom attributes that have to be updated for the existing contact Eg-{ "age" : 10, "gender" : "female" } | contact_id Unique alphanumeric ID of the contact 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 updated a contact Failure Error in updating a contact |
Update a Contact by Email and Phone
This method can be used to update a contact, if both phone number and email ID are known.
Method Name: Update a Contact by Email and Phone
This method can be used to update a contact, if both phone number and email ID are known.
| Input Variables | Output Variables | Nodes Outcomes |
|---|---|---|
| Subdomain Name of the subdomain associated with the company Eg-"healthcarecomms" Subdomain Name of the domain to which the company belongs Eg-"eclinic.org.uk", “imiassist.ai” Existing Phone Phone number of the existing contact. This will be used in identifying the contact to be updated Eg-"+919988676543"(phone number is prefixed with +country code) Existing Email Email Id of the existing contact. This will be used in identifying the contact to be updated Eg-"[email protected]” Api Key API key of the company Eg-"ca4356d0-an16-01e9-7ff9-23ab6aaded3a" Token Token that will be used to authenticate the request Eg-"6be695efdd16df50d15ac881651757680 0c0b9e25d47d6ae67ca40f169bfad5e" New Customer Id (Optional) New customer ID that has to be updated for the existing contact Eg-“NHSID_11” New Phone (Optional) New phone number that has to be updated for the existing contact in E.164 format. Eg-"+91994363457"(phone number is prefixed with +country code) New email (Optional) New email that has to be updated for the existing contact Eg-“[email protected]” New Custom Attributes (Optional) New custom attributes that have to be updated for the existing contact Eg- { "age" : 10, "gender" : "female" } | contact_id Unique alphanumeric ID of the contact 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 updated a contact Failure Error in updating a contact |
Delete a Contact by Contact ID
This method can be used to delete a contact, if the long alpha-numeric contact ID is known. (eg. contact ID: “6064541912511b001cb77e49”)
Method Name: Delete Contact by Contact ID
| 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” Contact Id ID of the existing contact that has to be deleted Eg- “5c75445d8eb2b817b465328d” 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" | contact_id Unique alphanumeric ID of the contact 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 deleted a contact Failure Error in deleting a contact |
Delete a Contact by Customer ID
This method can be used to delete a contact if the Contact ID is known.
Note:
Customer ID is used as a unique ID for a contact. Any unique ID such as social security number, customer registration number etc. can be stored as the Customer ID field in Webex Assist.
Method Name: Delete a Contact by Customer ID
| 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” Customer Id Unique customer ID of the existing contact that has to be deleted Eg- “5c75445d8eb2b817b465328d” 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" | contact_id Unique alphanumeric ID of the contact 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 deleted a contact Failure Error in deleting a contact |
Delete a Contact by Phone
This method can be used to delete a contact if the Phone Number is known.
Method Name: Delete a Contact by Phone
| 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” Phone Phone Number of the existing contact that has to be deleted in E.164 format. Eg-"+919446345798" (phone number is prefixed with +country code) 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" | contact_id Unique alphanumeric ID of the contact 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 deleted a contact Failure Error in deleting a contact |
Delete a Contact by Email
This method can be used to delete a contact if the Email ID is known.
Method Name: Delete a Contact by Email
| 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” Email of the existing contact that has to be deleted Eg-"[email protected]" 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 | contact_id Unique alphanumeric ID of the contact 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 deleted a contact Failure Error in deleting a contact |
Delete a Contact by Email and Phone
This method can be used to delete a contact if both Phone Number & Email ID are known.
| 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” Email of the existing contact that has to be deleted Eg-"[email protected]" Phone Phone number of the existing contact record in E.164 format. Eg-"+44123456789" (phone number is prefixed with +country code) Api Key API key of the company Eg- "ca4356d0-an16-01e9-7ff9-23ab6aaded3a" Token Token that will be used to authenticate the request Eg- "6be695efdd16df50d15ac88165175768 00c0b9e25d47d6ae67ca40f169bfad5e" | contact_id Unique alphanumeric ID of the contact 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 deleted a contact Failure Error in deleting a contact |
Updated 5 months ago