Update Records | Captain Docs

import json
import requests
import uuid
BASE_URL = "https://acme.captain.dev"
API_KEY = "your_write_key"
INDEX = "products"
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json",
    "Idempotency-Key": str(uuid.uuid4()),
}
response = requests.patch(
    f"{BASE_URL}/v1/indexes/{INDEX}/records",
    headers=headers,
    json={
        "records": [{"id": "sku-10482", "price": 119.0, "in_stock": False}],
    },
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

{
  "live_updates": "single_region",
  "regions_applied": [
    "us-east-1"
  ],
  "regions_pending": [
    "us-west-1",
    "us-east-2"
  ],
  "replicates_on_next_build": true,
  "index": "products",
  "seq": 1843,
  "accepted_at": 1759095310.482,
  "updated": 1,
  "deleted": 0,
  "served": true,
  "stale_until_build": [],
  "stale_features_until_build": []
}

Change fields on existing records without a build, or delete records with delete. Send each record’s id and only the fields to change: keyword, enum, identifier, number, date, geo and bool fields, and access lists. null clears a field. Up to 1,000 records per request. Changes apply in order within about a second. Text fields need a build (422 FIELD_NEEDS_REBUILD). The reply lists anything that waits for the next build.

Change fields on existing records without a build, or delete records with `delete`. Send each record's id and only the fields to change: keyword, enum, identifier, number, date, geo and bool fields, and access lists. `null` clears a field. Up to 1,000 records per request. Changes apply in order within about a second. Text fields need a build (422 FIELD_NEEDS_REBUILD). The reply lists anything that waits for the next build.

Authentication

AuthorizationBearer

A write key, issued by Captain. Server side only. Sent as Authorization: Bearer <key>.

Path parameters

indexstringRequiredformat: "^[a-z0-9][a-z0-9_-]{0,47}$"

index name

Request

This endpoint expects an object.

recordslist of objectsOptional

each: the id field plus the fields to set (keyword, enum, identifier, number, date, geo, bool, and the acl / deny fields). null clears a field

deletelist of stringsOptional

ids to delete

Response

accepted

live_updatesenumOptional

Live updates apply only on the region that accepted them.

Allowed values:

regions_appliedlist of stringsOptional

The region where this update applies, within about a second (GET …/updates shows when).

regions_pendinglist of stringsOptional

Regions without this update until the index's next build is published and restored there.

replicates_on_next_buildbooleanOptional

True when builds are published to every region: the next build started after this update carries it everywhere (one accepted while a build runs waits for the build after).

indexstringOptional

seqintegerOptional

accepted_atdoubleOptional

updatedintegerOptional

deletedintegerOptional

servedbooleanOptional

stale_until_buildlist of stringsOptional

fields updated for filters, facets and sort at once, whose words the keyword lanes see only after the next build

stale_features_until_buildlist of enumsOptional

what still reflects the data before this update until the next build: typeahead, spelling and search_evidence (the no-typed-word answer) keep a deleted record’s words and do not learn a changed value’s words; hit_display: values shown on hits from the record’s mapped roles (rating, price, title…). Filters, sort, facets, hit.fields and GET change at once

Allowed values:

Authentication

Path parameters

Headers

Request

Response