Developers API reference Version 1 · generated from the code openapi.json
Routes

organize

Move binders and flows

POST /api/v1/move

Move items into a binder (target: its id), to the root of your own space (root) or of an organisation (org:<id>).

A move that would close content to its readers, change who it is shared with or make it public is not done at once: it answers 409 confirmation_required with what would change, and is to be sent again with confirmed: true. Items that cannot be moved are skipped and counted in ignored.

Required scope: write

Request body application/json

  • items array of Item · required

    What to move.

    2 fields
    • type string · required

      What it is.

    • id integer · required

      Its id.

  • target string · required

    Where to: the id of a binder, root (the root of your own space) or org:<id> (the root of an organisation).

  • confirmed boolean · optional

    Set to true to go through with a move that answered confirmation_required.

Response

200 Moved

  • moved array of Item

    What was moved.

    2 fields
    • type string

      What it is.

    • id integer

      Its id.

  • ignored integer

    Number of items left where they were: not found, or not movable there.

  • now_online integer

    Number of items the move opened to their readers.

Errors

  • 401

    No valid credential.

  • 403

    The credential lacks the required scope, or the account may not do this.

  • 409

    The current state of the content forbids the request.

  • 422

    A value is missing or malformed.

  • 429

    Too many requests; Retry-After gives the seconds to wait.

planner_banner_ad_pt