PATCH
/
v3
/
index
/
{name}
Update an index
curl --request PATCH \
  --url https://{region}.affinda.com/v3/index/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "my-index"
}'
{
  "name": "my-index",
  "docType": "resumes",
  "user": {
    "id": 1,
    "name": "Carl Johnson",
    "email": "carljohnson@grove.street",
    "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Path Parameters

​
name
string
required

Index name

Example:

"my-index"

Body

application/json

Index data to update

The body is of type object.

Response

200
application/json

Successfully updated index data.

The response is of type object.