API Documentation
API Documentation
  • Overview
  • Terms & Guidelines
  • Rest API v1
    • Authentication
      • Obtain access token
      • Make authorized calls
    • Collections
      • Collection methods
      • Nested structure
      • Sharing
      • Covers/icons
    • Raindrops
      • Single raindrop
      • Multiple raindrops
    • Highlights
    • User
      • Authenticated user
    • Tags
    • Filters
    • Import
    • Export
    • Backups
  • More
    • Changelog
    • Showcase
Powered by GitBook
On this page
  • Get raindrop
  • Create raindrop
  • Update raindrop
  • Remove raindrop
  • Upload file
  • Upload cover
  • Get permanent copy
  • Suggest collection and tags for new bookmark
  • Suggest collection and tags for existing bookmark

Was this helpful?

  1. Rest API v1
  2. Raindrops

Single raindrop

In this page you will find how to retrieve, create, update or delete single raindrop.

Get raindrop

GET https://api.raindrop.io/rest/v1/raindrop/{id}

Path Parameters

Name
Type
Description

id*

number

Existing raindrop ID

Create raindrop

POST https://api.raindrop.io/rest/v1/raindrop

Description and possible values of fields described in "Fields"

Request Body

Name
Type
Description

pleaseParse

object

Specify empty object to automatically parse meta data (cover, description, html) in the background

created

string

lastUpdate

string

order

number

Specify sort order (ascending). For example if you want to move raindrop to the first place set this field to 0

important

boolean

tags

array

media

array

cover

string

collection

object

type

string

excerpt

string

title

string

link*

string

highlights

array

reminder

object

{
    "result": true,
    "item": {
        ...
    }
}

Update raindrop

PUT https://api.raindrop.io/rest/v1/raindrop/{id}

Description and possible values of fields described in "Fields"

Path Parameters

Name
Type
Description

id*

number

Existing raindrop ID

Request Body

Name
Type
Description

created

string

lastUpdate

string

pleaseParse

object

Specify empty object to re-parse link meta data (cover, type, html) in the background

order

number

Specify sort order (ascending). For example if you want to move raindrop to the first place set this field to 0

important

boolean

tags

array

media

array

cover

string

collection

object

type

string

excerpt

string

title

string

link

string

highlights

array

reminder

object

{
    "result": true,
    "item": {
        ...
    }
}

Remove raindrop

DELETE https://api.raindrop.io/rest/v1/raindrop/{id}

When you remove raindrop it will be moved to user Trash collection. But if you try to remove raindrop from Trash, it will be removed permanently.

Path Parameters

Name
Type
Description

id*

number

Existing raindrop ID

{
    "result": true
}

Upload file

PUT https://api.raindrop.io/rest/v1/raindrop/file

Headers

Name
Type
Description

Content-Type*

string

multipart/form-data

Request Body

Name
Type
Description

file*

object

File

collectionId

String

Collection Id

{
    "result": true,
    "item": {
        "title": "File name",
        "type": "image",
        "link": "https://up.raindrop.io/raindrop/111/file.jpeg",
        "domain": "raindrop.io",
        "file": {
            "name": "File name.jpeg",
            "size": 10000
        }
        ...
    }
}
//file is not specified
{
  "result": false,
  "error": -1,
  "errorMessage": "no file"
}

//unsupported file format
{
  "result": false,
  "error": "file_invalid",
  "errorMessage": "File is invalid"
}

//file size is big
{
  "result": false,
  "error": "file_size_limit",
  "errorMessage": "File size limit"
}

Upload cover

PUT https://api.raindrop.io/rest/v1/raindrop/{id}/cover

PNG, GIF or JPEG

Path Parameters

Name
Type
Description

id*

number

Existing raindrop ID

Headers

Name
Type
Description

Content-Type*

string

multipart/form-data

Request Body

Name
Type
Description

cover*

object

File

{
    "result": true,
    "item": {
        "cover": "https://up.raindrop.io/raindrop/...",
        "media": [
            {
                "link": "https://up.raindrop.io/raindrop/..."
            }
        ]
        ...
    }
}
//file is not specified
{
  "result": false,
  "error": -1,
  "errorMessage": "no file"
}

//unsupported file format
{
  "result": false,
  "error": "file_invalid",
  "errorMessage": "File is invalid"
}

//file size is big
{
  "result": false,
  "error": "file_size_limit",
  "errorMessage": "File size limit"
}

Get permanent copy

GET https://api.raindrop.io/rest/v1/raindrop/{id}/cache

Links permanently saved with all content (only in PRO plan). Using this method you can navigate to this copy.

Path Parameters

Name
Type
Description

id*

number

Existing raindrop ID

Location: https://s3.aws...

Suggest collection and tags for new bookmark

POST https://api.raindrop.io/rest/v1/raindrop/suggest

Request Body

Name
Type
Description

link*

string

{
    "result": true,
    "item": {
        "collections": [
            {
                "$id": 568368
            },
            {
                "$id": 8519567
            },
            {
                "$id": 1385626
            },
            {
                "$id": 8379661
            },
            {
                "$id": 20865985
            }
        ],
        "tags": [
            "fonts",
            "free",
            "engineering",
            "icons",
            "invalid_parser"
        ]
    }
}

Suggest collection and tags for existing bookmark

GET https://api.raindrop.io/rest/v1/raindrop/{id}/suggest

Path Parameters

Name
Type
Description

*

String

Bookmark id

{
    "result": true,
    "item": {
        "collections": [
            {
                "$id": 568368
            },
            {
                "$id": 8519567
            },
            {
                "$id": 1385626
            },
            {
                "$id": 8379661
            },
            {
                "$id": 20865985
            }
        ],
        "tags": [
            "fonts",
            "free",
            "engineering",
            "icons",
            "invalid_parser"
        ]
    }
}
PreviousRaindropsNextMultiple raindrops

Last updated 1 year ago

Was this helpful?

Make sure to send PUT request with body

multipart/form-data