---
title: "Update an index"
method: PATCH
path: "/v3/index/{name}"
tags: ["Search & Match"]
---

# Update an index

`PATCH /v3/index/{name}`

Updates the specified index

## Path parameters

- `name` string, required — Unique index name

## Request body

- IndexUpdate
  - `name` string — Unique index name

## Response `200`

Successfully updated index data.

- Index
  - `name` string, required — Unique index name
  - `docType` 'resumes' | 'job_descriptions', required
  - `user` IndexUser, required — The user who created this index
    - `id` integer, required — Uniquely identify a user.
    - `name` string, required
    - `email` string, required
    - `avatar` string, nullable, required — URL of the user's avatar.

## Other responses

- `400` — Bad request. If it is a validation error will contain a list of each invalid field
- `401` — Authorisation error
- `default` — UnexpectedError

---

[API](https://skmtc.net/affinda/apis/affinda-api-2.md) · [All operations](https://skmtc.net/affinda/apis/affinda-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/affinda/affinda-api-2/versions/6772e50cb58e/schema)