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

flows

Create a flow

POST /api/v1/flows

Create a flow inside binder_id, or at the root of space when no binder is given (default: your own space).

It is born offline, with one empty first step in its draft.

Required scope: write

Request body application/json

  • name string · required

    Name, 1 to 200 characters.

  • binder_id integer or null · optional

    Id of the binder to create it in.

  • space string or null · optional

    With no binder, the space to create it at the root of: me (default) or org:<id>.

Response

201 Flow

  • id integer

    Id, unique among the objects of its type.

  • type string

    Always flow.

  • name string

    Its name.

  • role string or null

    Role of the account on it: owner, editor or reader; null when it holds none of its own.

  • 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.

  • parent_id integer or null

    Id of the binder that holds it; null at the root of a space.

  • organisation_id integer or null

    Id of the organisation whose space it lives in; null in a personal space.

  • owner Owner

    The account that owns it.

    2 fields
    • id integer

      Id of the account.

    • name string

      Its name, or its address when it has none.

  • created_at date-time

    When it was created.

  • updated_at date-time

    When it was last changed.

  • is_published boolean

    Whether a published version exists.

  • published_at date-time or null

    When it was last published; null when it never was.

  • has_unpublished_changes boolean or null

    Whether the draft differs from the published version. null for who may not edit the flow.

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