Skip to content

Latest commit

 

History

History
377 lines (309 loc) · 13.4 KB

single.md

File metadata and controls

377 lines (309 loc) · 13.4 KB
Raw
description
In this page you will find how to retrieve, create, update or delete single raindrop.

Single raindrop

Get raindrop

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

Path Parameters

Name Type Description
id* number Existing raindrop ID

{% tabs %} {% tab title="200 " %}

{% endtab %} {% endtabs %}

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

{% tabs %} {% tab title="200 " %}

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

{% endtab %} {% endtabs %}

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

{% tabs %} {% tab title="200 " %}

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

{% endtab %} {% endtabs %}

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

{% tabs %} {% tab title="200 " %}

{
    "result": true
}

{% endtab %} {% endtabs %}

Upload file

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

Make sure to send PUT request with multipart/form-data body

Headers

Name Type Description
Content-Type* string multipart/form-data

Request Body

Name Type Description
file* object File
collectionId String Collection Id

{% tabs %} {% tab title="200 " %}

{
    "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
        }
        ...
    }
}

{% endtab %}

{% tab title="400 " %}

//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"
}

{% endtab %} {% endtabs %}

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

{% tabs %} {% tab title="200 " %}

{
    "result": true,
    "item": {
        "cover": "https://up.raindrop.io/raindrop/...",
        "media": [
            {
                "link": "https://up.raindrop.io/raindrop/..."
            }
        ]
        ...
    }
}

{% endtab %}

{% tab title="400 " %}

//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"
}

{% endtab %} {% endtabs %}

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

{% tabs %} {% tab title="307 " %}

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

{% endtab %} {% endtabs %}

Suggest collection and tags for new bookmark

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

Request Body

Name Type Description
link* string

{% tabs %} {% tab title="200 " %}

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

{% endtab %} {% endtabs %}

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

{% tabs %} {% tab title="200 " %}

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

{% endtab %} {% endtabs %}