Add or replace a record

Adds a record to an index or replace it.

  • If the record doesn’t have an object ID, a new record with an auto-generated object ID is added to your index.
  • If a record with the specified object ID exists, the existing record is replaced.
  • If a record with the specified object ID doesn’t exist, a new record is added to your index.
  • If you add a record to an index that doesn’t exist yet, a new index is created.

To update some attributes of a record, use the partial operation. To add, update, or replace multiple records, use the batch operation.

Usage

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

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

var response = client.saveObject(
  indexName = "ALGOLIA_INDEX_NAME",
  body = buildJsonObject {
    put(
      "objectID",
      JsonPrimitive("id"),
    )
    put(
      "test",
      JsonPrimitive("val"),
    )
  },
)
Did you find this page helpful?
Kotlin API clients v3