Partially update interaction context mapping

Partially updates an interaction context mapping, with the same rules as Create interaction context mapping. Only provided fields are updated; the rest keep their stored values.

sources, when given, replaces every source of the mapping: a source type left out of the object is removed. To keep both source types, send both. field_type cannot be changed: a different value answers 422. context_key stays as created when name changes.

If the mapping is assigned to Voiso AI agents, they are updated with it; when the AI agent service fails, the API answers 502 and changes nothing.

Requires the contact_center.interaction_context_mappings.manage scope.

Path Params
integer
required

The unique identifier of the interaction context mapping.

Body Params
string
length ≤ 100

The field name, unique in the contact center.

string
enum

The field type. Cannot be changed; only the stored value is accepted.

Allowed:
string
length ≤ 2048

What the AI agent listens for, at most 2048 characters and 2048 bytes. Only for collected_by_ai_agent.

sources
object

The metadata sources, only for imported. Replaces every source of the mapping: a source type left out is removed.

boolean

Whether the field is shown in Agent Workspace.

boolean

Whether the field can be used in the prompt and greeting message of Voiso AI agents. Not allowed with a sip_header source or for collected_by_ai_agent.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json