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

favorites

Add a favorite

POST /api/v1/favorites

Keep a binder or a flow the account can see -- its own, one shared with it, or a public one. Adding it again answers 200 with the favorite already there.

Required scope: write

Request body application/json

  • type string · required

    What to keep: a binder or a flow.

  • id integer · required

    Id of the binder or the flow.

Response

200 Favorite

  • id integer

    Id of the favorite.

  • type string

    What it keeps: a binder or a flow.

  • entity_id integer or null

    Id of the binder or the flow; null once it was deleted.

  • name string

    Its name, as last seen while it opened.

  • state string

    available: it opens. closed: still there, taken offline by its author -- it does not open. unavailable: deleted, or no longer shared with you, no longer public, or out of an organisation you left. A favorite is never removed on its own.

  • created_at date-time

    When it was added.

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