STstonly
guide

Link existing steps

Connects two existing steps with a navigation transition.

post/guide/step/link

Request

  • Base URL
    https://public.stonly.com/api/v3
  • Auth
    HTTP basic

Query parameters

teamIdinteger

ID of the team to manage. Optional if the API key is associated with a single team.

Request body

guideIdstring required

Unique guide ID (public identifier)

sourceStepIdinteger required

ID of the source step from which the link will be created. Cannot be END_OF_GUIDE (-1), INTRODUCTION_TO_GUIDE (-2), EXTERNAL_LINK_FROM_GUIDE (-3), STEP_AD (-4), STEP_WIDGET_ACTION (-5), or STEP_AI_ACTION (-6)

targetStepIdinteger required

ID of the target step to which the link will point

choiceLabelstring

Label for the navigation button to the target step in the guide's default language (optional)

positioninteger

Position index for inserting the link among existing next steps (optional, defaults to end)

Example request

{
  "guideId": "ioTkq4uNhy",
  "sourceStepId": 123,
  "targetStepId": 456,
  "choiceLabel": "Next Option"
}

Response

Steps successfully linked.

successboolean

Indicates successful link creation.

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.