Tool to add or update a synonym in the specified index. Use when you need programmatic upsert of search synonyms after index creation.
synonymRequiredobjectSynonym object payload defining type and values.
objectIDRequiredstringUnique identifier for the synonym object. Must be specified and match the synonym objectID.
indexNameRequiredstringName of the index in which to save the synonym.
forwardToReplicasbooleanWhether to forward the synonym update to all replicas.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.