Create or replace a synonym

If a synonym with the specified object ID doesn’t exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the batch operation.

Usage

Required ACL: editSettings
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import com.algolia.client.api.SearchClient
import com.algolia.client.configuration.*
import com.algolia.client.transport.*
import com.algolia.client.extensions.*

val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

var response = client.saveSynonym(
  indexName = "ALGOLIA_INDEX_NAME",
  objectID = "id1",
  synonymHit = SynonymHit(
    objectID = "id1",
    type = SynonymType.entries.first { it.value == "synonym" },
    synonyms = listOf("car", "vehicule", "auto"),
  ),
  forwardToReplicas = true,
)
Did you find this page helpful?
Kotlin API clients v3