POST drills

Creates a new drill. The created drill will be empty, and private to the creator's user account. The assigned drill ID is returned in the response.

Resource URL

https://www.drillster.com/api/2.1.1/drills

Parameters

Field	Description
`name` required	The name of the newly created drill. If a drill with the given name already exists in the user's repertoire, a sequence number is appended in brackets. The new drill's recorded name is always returned in the response. Example value: `French Made Easy chapter 1`
`subject` required	The subject matter of the drill. Example value: `French`
`description` required	A description of the drill. The description is used to tell users about the drill to help them decide whether the drill is appropriate for them. Example value: `Contains the idiom list from chapter 1 of the book French Made Easy.`
`tags` optional	An array of tags to be associated with the new drill. Example value: `german`

Response

A 2.1.1 Drill object with the details of the created drill, including the ID and the name. The name is echoed because of the possibility that a sequence number is appended to it.

Example request

POST https://www.drillster.com/api/2.1/drills
name=French+Made+Easy+chapter+1
subject=French
description=Contains+the+idiom+list+from+chapter+1+of+the+book+French+Made+Easy.

Response

{
  "id": "R_GVlYZQTKOEmN_r69EVFQ",
  "name": "French Made Easy chapter 1",
  "type": "DRILL"
}

The type is used to differentiate drills from courses, and will be set to DRILL in all cases for this API call.

Error responses

The following error situations are possible:

ID	Description
`no_input`	No input received
`name_missing`	No drill name specified
`subject_missing`	No drill subject specified
`description_missing`	No drill description specified
`invalid_tag`	One of the tags is invalid
`subject_equal_to_name`	Drill subject must not be equal to name
`limit_reached`	The storage limit for this account has been reached

Last updated on 2025-04-18