Skip to main content
PUT
/
1
/
indexes
/
{indexName}
/
{objectID}
curl
curl --request PUT \
  --url https://algolia_application_id.algolia.net/1/indexes/ALGOLIA_INDEX_NAME/test-record-123 \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '{"objectID":"blackTShirt","name":"Black T-shirt","color":"#000000"}'
{
  "taskID": 1514562690001,
  "updatedAt": "2023-07-04T12:49:15Z",
  "objectID": "test-record-123"
}
Required ACL: addObject

Authorizations

​
x-algolia-application-id
string
header
required

Your Algolia application ID.

​
x-algolia-api-key
string
header
required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

​
indexName
string
required

Name of the index on which to perform the operation.

Example:

"ALGOLIA_INDEX_NAME"

​
objectID
string
required

Unique record identifier.

Example:

"test-record-123"

Body

application/json · object

The record. A schemaless object with attributes that are useful in the context of search and discovery.

The body is of type object.

Response

OK

Response, taskID, unique object identifier, and an update timestamp.

​
taskID
integer

Unique identifier of a task.

A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the task operation and this task ID.

Example:

1514562690001

​
updatedAt
string

Date and time when the object was updated, in RFC 3339 format.

Example:

"2023-07-04T12:49:15Z"

​
objectID
string

Unique record identifier.

Example:

"test-record-123"

⌘I