Skip to content
REST API

Update a study set

PATCH
/sets/{setId}

Changes the name, description or subject. Only the fields you send change; null clears a nullable field. Terms and their review history are never touched.

Required scopes: sets:update

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

setId*string

Study set id, scoped to the key's user.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Send only the fields to change. An omitted field stays as it is. Terms are never touched.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/sets/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "7e6d5c4b-3a2f-4e1d-8c0b-9a8f7e6d5c4b",    "name": "Spanish verbs",    "description": "Irregular preterite forms.",    "subjectId": "5f0c1d2e-3a4b-4c5d-8e6f-7a8b9c0d1e2f",    "termCount": 1,    "createdAt": "2026-01-15T09:30:00.000Z",    "lastUsed": "2026-02-01T12:00:00.000Z",    "updatedAt": "2026-02-01T12:00:00.000Z"  }}