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

steps

Remove the image of a step

DELETE /api/v1/steps/{step_id}/image

Remove the image of a step of the draft.

Required scope: write

Path parameters

  • step_id integer · required

    Id of the step.

Response

200 Step

  • id integer

    Id of the step. The draft and the published version of a flow carry different ids.

  • reference string

    Short name of the step, unique in its version: what buttons point at.

  • order integer

    Rank in the flow, from 1.

  • title string

    Title. Empty for a reader when the author hid it.

  • content string

    Text, as HTML. Empty for a reader when the author hid it.

  • image_url string or null

    Where to download the image, with the same credential; null without image, or when the author hid it from readers.

  • image_fit string or null

    contain shows the whole image, cover fills its frame. null: never chosen, shown as contain.

  • updated_at date-time

    When it was last changed.

  • display_title boolean or null

    Whether readers see the title. Only given to who may edit.

  • display_content boolean or null

    Whether readers see the text. Only given to who may edit.

  • display_image boolean or null

    Whether readers see the image. Only given to who may edit.

  • buttons array of Button or null

    Its navigation buttons, in order.

    6 fields
    • id integer

      Id of the button.

    • label string

      What the button says.

    • target_step_id integer or null

      Id of the step it leads to; null when it ends the flow, or when its target was deleted.

    • target_reference string

      Reference of the step it leads to, kept after that step is deleted; empty when it ends the flow.

    • ends_procedure boolean

      Whether it ends the flow.

    • target_missing boolean

      Whether it points at a step that was deleted. A draft cannot be published while one remains.

  • faults array of string or null

    Draft only, what the editor flags: missing_target (a button points at a deleted step; blocks publishing) or unreachable (no button of another step leads here).

Errors

  • 401

    No valid credential.

  • 403

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

  • 404

    Nothing with that id, or nothing the account may open.

  • 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