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

buttons

Add a navigation button

POST /api/v1/steps/{step_id}/buttons

Add a button to a step of the draft. link says where it leads:

  • to_new creates a step named reference and points at it;
  • to_exist points at the existing step named reference;
  • to_end ends the flow.

Required scope: write

Path parameters

  • step_id integer · required

    Id of the step.

Request body application/json

  • label string · required

    What the button says.

  • link string · required

    to_new: create a step and point at it. to_exist: point at an existing step. to_end: end the flow.

  • reference string or null · optional

    Reference of the target step: the one to create (to_new) or the existing one (to_exist). Unused for to_end.

Response

201 Button

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

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