Update an interaction channel

Learn about the Update endpoint in the InteractionChannel collection.

This API lets you update the details of an existing interaction channel.

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

API request

Parameters

Parameter	Description
id	Unique identifier of the interaction channel.
projectId	Unique identifier of the project to which the interaction channel belongs. Notes: Whether or not you need to enter the project ID depends on your user account; If you are working with a private solution, you might need to enter the project ID instead of the project domain ID. On the other hand, if you are working with a public solution, you might need to enter the project domain and function ID. From the same tenant profile, you can manage several projects.
project_Domain_Id	Unique identifier of the project's domain. Note: Whether or not you need to enter the project domain ID depends on your user account; If you are working with a private solution, you might need to enter the project ID instead of the project domain ID. On the other hand, if you are working with a public solution, you might need to enter the project domain and function ID. This parameter can have the following values:
project_Function_Id	Unique identifier of the project's function based on the project's domain. Note: Whether or not you need to enter the project function ID depends on your user account; If you are working with a private solution, you might need to enter the project ID instead of the project domain ID. On the other hand, if you are working with a public solution, you might need to enter the project domain and function ID. This parameter can have the following values: For No domain (when project_Domain_Id is -1) For Security & Safety (when project_Domain_Id is 2) For Human wellbeing (when project_Domain_Id is 3) For Digital user experience (project_Domain_Id is 4)
identifier	Name of the interaction channel.
value	A value that helps to identify the interaction channel. For example, for an input interaction channel where the input is captured through an IP camera, value will be its streaming IP address.
active	Indicates whether the interaction channel is active.
interaction_Input_Category_Id	(For input channels) Unique identifier of the category to which the input interaction channel belongs
interaction_Input_Types_Id	(For input channels) Unique identifier of the input type. This parameter can have the following values:
interaction_Channel_Types_Id	Unique identifier of the interaction channel type. This parameter can have the following values:
triggered_Action_Id	(For output channels) Unique identifier of the triggered action.
destination_Entity_Id	(For output channels) The entity that receives the output
destination_Entity_Object_Id	(For output channels) The object that receives the output