Skip to content
REST API

Add terms to a study set

POST
/sets/{setId}/terms

Appends up to 500 terms per call. Existing terms and their review history stay as they are. A set holds at most 2000 terms, and a call that would pass that adds nothing.

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

Header Parameters

Idempotency-Key?string

A client-generated key (1 to 255 visible ASCII characters) that makes this POST safe to retry. A retry with the same key and body replays the original response; the same key with a different body returns 409 idempotency_conflict. Stored for 24 hours.

Match^[\x21-\x7E]{1,255}$
Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/sets/497f6eca-6276-4993-bfeb-53cbbbba6f08/terms" \  -H "Content-Type: application/json" \  -d '{    "terms": [      {        "term": "string",        "definition": "string"      }    ]  }'
{  "data": {    "terms": [      {        "id": "6c5b4a39-2817-4f06-9e5d-4c3b2a190817",        "term": "ser (yo)",        "definition": "fui",        "hints": []      }    ],    "termCount": 2  }}