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

organize

Put several items online or offline

POST /api/v1/bulk/online

Apply the setting to each item the account may edit and whose setting differs; the others are skipped. changed lists every binder and flow whose status moved, what the binders hold included.

Required scope: publish

Request body application/json

  • items array of Item · required

    What to act on.

    2 fields
    • type string · required

      What it is.

    • id integer · required

      Its id.

  • online boolean · required

    true to open them to their readers, false to close them.

Response

200 BulkOnlineDone

  • applied integer

    Number of items the setting was applied to.

  • changed array of StatusChange

    Every binder and flow whose status moved, what the binders hold included.

    3 fields
    • type string

      What it is.

    • id integer

      Its id.

    • online_status string

      online: open to its readers. offline: closed. pending_online / pending_offline: inside a binder that is not online, hence closed; the setting is recorded and applies when the parent goes online.

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