POST
/
create-flashcard
curl --request POST \
  --url http://dolphinflashcards.com/api/create-flashcard \
  --header 'Content-Type: application/json' \
  --data '{
  "userID": "user1",
  "flashcardName": "firstCard",
  "flashcardDescription": "my first flashcard",
  "folder": "top-level-parent-name/parent-name-2/parent-name-3",
  "cards": [
    {
      "front": "Monday",
      "back": "Evening",
      "reviewStatus": "0.0",
      "lastReview": "13/08/2024"
    }
  ]
}'
[
  {
    "200": 123,
    "success": true
  }
]

Body

application/json
​
userID
string
required

The unique ID of the user editing or creating flashcards.

Example:

"user1"

​
flashcardName
string
required

The name of the flashcard set.

Example:

"firstCard"

​
flashcardDescription
string
required

The description of the flashcard set

Example:

"my first flashcard"

​
folder
string
required

The name of the folder containing the flashcard sets. Set to "" to set as a top level flashcard, otherwise set it to the parent folder name. If there are multiple parent folders, add the folder name seperated by numeric figures.

Example:

"top-level-parent-name/parent-name-2/parent-name-3"

​
cards
object[]
required

A list of flashcards. Each flashcard object has front, back, review status, and last review properties.

Response

200
application/json
OK. Returned when the request is successfully executed.
​
200
integer

HTTP status code indicating a successful operation.

​
success
boolean

Indicates that a new flashcard was created successfully.