Skip to content

Latest commit

 

History

History
142 lines (108 loc) · 9.16 KB

multiple.md

File metadata and controls

142 lines (108 loc) · 9.16 KB
Raw
description
In this page you will find how to retrieve, create, update or delete multiple raindrops at once.

Multiple raindrops

Common parameters

To filter, sort or limit raindrops use one of the parameters described below. Check each method for exact list of supported parameters.

Parameter Type Description
collectionId Integer

Path parameter that specify from which collection to get raindrops. Or specify one of system:

0 to get all (except Trash)

-1 to get from "Unsorted"

-99 to get from "Trash"

Warning: update or remove methods not support 0 yet. Will be fixed in future.
search String

As text, check all examples here

You can first test your searches in Raindrop app and if it works correctly, just copy content of search field and use it here
sort String

Query parameter for sorting:

-created by date descending (default)

created by date ascending

score by relevancy (only applicable when search is specified)

-sort by order

title by title (ascending)

-title by title (descending)

domain by hostname (ascending)

-domain by hostname (descending)
page Integer Query parameter. 0, 1, 2, 3 ...
perpage Integer Query parameter. How many raindrops per page. 50 max
ids Array<Integer> You can specify exact raindrop ID's for batch update/remove methods
nested Boolean Also include bookmarks from nested collections (true/false)

Get raindrops

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

Path Parameters

Name Type Description
collectionId* number Collection ID. Specify 0 to get all raindrops

Query Parameters

Name Type Description
sort string
perpage number
page number
search string
nested boolean

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

{% endtab %} {% endtabs %}

Create many raindrops

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

Request Body

Name Type Description
items* array

Array of objects. Format of single object described in "Create single raindrop".
Maximum 100 objects in array!

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

{
    "result": true,
    "items": [
        {
            ...
        }
    ]
}

{% endtab %} {% endtabs %}

Update many raindrops

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

Specify optional search and/or ids parameters to limit raindrops that will be updated.
Possible fields that could be updated are described in "Body Parameters"

Path Parameters

Name Type Description
collectionId* number
nested boolean

Request Body

Name Type Description
ids array
important boolean

TRUE - mark as "favorite"
FALSE - unmark as "favorite"
tags array

Will append specified tags to raindrops.
Or will remove all tags from raindrops if [] (empty array) is specified
media array

Will append specified media items to raindrops.
Or will remove all media from raindrops if [] (empty array) is specified
cover string

Set URL for cover.
Tip: specify <screenshot> to set screenshots for all raindrops
collection object Specify {"$id": collectionId} to move raindrops to other collection

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

{% endtab %} {% endtabs %}

Remove many raindrops

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

Specify optional search and/or ids parameters to limit raindrops that will be moved to "Trash"
When :collectionId is -99, raindrops will be permanently removed!

Path Parameters

Name Type Description
collectionId* number
nested boolean

Query Parameters

Name Type Description
search string

Request Body

Name Type Description
ids array

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

{
    "result": true,
    "modified": 330
}

{% endtab %} {% endtabs %}