Highlights
Single highlight
object:
_id
String
Unique id of highlight
text
String
Text of highlight (required)
title
String
Title of bookmark
color
String
Color of highlight.
Default yellow
Can be blue
, brown
, cyan
, gray
, green
, indigo
, orange
, pink
, purple
, red
, teal
, yellow
note
String
Optional note for highlight
created
String
Creation date of highlight
tags
Array
Tags list
link
String
Highlighted page URL
Get all highlights
GET
https://api.raindrop.io/rest/v1/highlights
Query Parameters
page
Number
perpage
Number
How many highlights per page. 50 max. Default 25
Get all highlights in a collection
GET
https://api.raindrop.io/rest/v1/highlights/{collectionId}
Path Parameters
collectionId*
Number
Collection ID
page
Number
perpage
Number
How many highlights per page. 50 max. Default 25
Get highlights of raindrop
GET
https://api.raindrop.io/rest/v1/raindrop/{id}
Path Parameters
id*
number
Existing raindrop ID
Add highlight
PUT
https://api.raindrop.io/rest/v1/raindrop/{id}
Just specify a highlights
array in body with object
for each highlight
Fore example:
{"highlights": [ { "text": "Some quote", "color": "red", "note": "Some note" } ] }
Path Parameters
id*
number
Existing raindrop ID
Request Body
highlights*
array
highlights[].text*
String
highlights[].note
String
highlights[].color
String
Update highlight
PUT
https://api.raindrop.io/rest/v1/raindrop/{id}
Just specify a highlights
array in body with object
containing particular _id
of highlight you want to update and all other fields you want to change.
Fore example:
{"highlights": [ { "_id": "62388e9e48b63606f41e44a6", "note": "New note" } ] }
Path Parameters
id*
number
Existing raindrop ID
Request Body
highlights*
array
highlights[]._id*
String
Particular highlight _id you want to remove
highlights[].text
String
Should be empty string
highlights[].note
String
highlights[].color
String
Remove highlight
PUT
https://api.raindrop.io/rest/v1/raindrop/{id}
Just specify a highlights
array in body with object
containing particular _id
of highlight you want to remove and empty string for text
field.
Fore example:
{"highlights": [ { "_id": "62388e9e48b63606f41e44a6", "text": "" } ] }
Path Parameters
id*
number
Existing raindrop ID
Request Body
highlights*
array
highlights[]._id*
String
Particular highlight _id you want to remove
highlights[].text*
String
Should be empty string
Last updated
Was this helpful?