Skip to content
WorkRoad home
REST API

Update several terms

PATCH
/sets/{setId}/terms

Changes up to 500 terms of one set in one call. Send each term's termId with only the fields to change. Every term keeps its id, image and review history. All the changes are saved together, or none when a termId isn't the set's.

Use this to save content you wrote yourself. It uses none of the user's WorkRoad AI uses.

Required scopes: sets:update

Authorization

headerAuthorizationBearer <token>

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
  1. body
terms*array<>

1-500 terms, each with its termId and only the fields to change.

Items1 <= items <= 500

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PATCH 'https://workroad.app/api/v1/sets/497f6eca-6276-4993-bfeb-53cbbbba6f08/terms' \  -H 'Authorization: Bearer $WORKROAD_API_KEY' \  -H 'Content-Type: application/json' \  -d '{  "terms": [    {      "termId": "928ed303-93ba-4a4d-ad80-c8fb71f9e31e"    }  ]}'
Example Response
{  "data": {    "terms": [      {        "id": "2a1b0c9d-8e7f-4a6b-9c5d-4e3f2a1b0c9d",        "term": "tener (yo)",        "definition": "tuve",        "hints": [          "irregular stem tuv-"        ]      }    ]  }}

Update a term PATCH

Changes the term, definition or hints. Only the fields you send change.

Get the dashboard layout GET

The dashboard cards shown, in order, and their sizes.