STstonly
guide

Append a step

Appends a new step to an existing guide after a specific parent step. Returns the newly created stepId.

post/guide/step

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)

parentStepIdinteger required

ID of the parent step after which the new step will be added

titlestring

Title of the new step (optional, max 255 characters)

choiceLabelstring

Label for the navigation button to this step (optional)

contentstring required

HTML content for the step (max 800000 characters)

language'am' | 'ar' | 'bg' | 'bn' | 'bs' | 'ca' | 'cn' | 'cs' | 'cy' | 'da' | 'de' | 'de-AT' | 'de-CH' | 'el' | 'en' | 'en-GB' | 'en-US' | 'es' | 'es-CL' | 'es-EC' | 'et' | 'eu' | 'fa' | 'fi' | 'fr' | 'fr-BE' | 'fr-CA' | 'ga' | 'gd' | 'he' | 'hi' | 'hr' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'kn' | 'ko' | 'lt' | 'lv' | 'mi' | 'mk' | 'nb' | 'nl' | 'nl-BE' | 'nn' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'sl' | 'sq' | 'sr' | 'sv' | 'sw' | 'th' | 'tl' | 'tr' | 'uk' | 'ur' | 'vi' | 'zh' | 'zh-Hant'

The ISO 639-1 language code (with some regional variants). Supported values map as follows:

|---|---|---|---|---|---| | am | Amharic | ar | Arabic | bg | Bulgarian | | bn | Bengali | bs | Bosnian | ca | Catalan | | cn | Montenegrin | cs | Czech | cy | Welsh | | da | Danish | de | German | de-AT | German (Austria) | | de-CH | German (Switzerland) | el | Greek | en | English | | en-GB | English (UK) | en-US | English (US) | es | Spanish | | es-CL | Spanish (Chile) | es-EC | Spanish (Ecuador) | et | Estonian | | eu | Basque | fa | Persian | fi | Finnish | | fr | French | fr-BE | French (Belgium) | fr-CA | French (Canada) | | ga | Irish | gd | Scots Gaelic | he | Hebrew | | hi | Hindi | hr | Croatian | hu | Hungarian | | hy | Armenian | id | Indonesian | is | Icelandic | | it | Italian | ja | Japanese | ka | Georgian | | kn | Kannada | ko | Korean | lt | Lithuanian | | lv | Latvian | mi | Maori | mk | Macedonian | | nb | Norwegian Bokmål | nl | Dutch | nl-BE | Flemish | | nn | Norwegian Nynorsk | no | Norwegian | pl | Polish | | pt | Portuguese | pt-BR | Portuguese (Brazil) | ro | Romanian | | ru | Russian | sk | Slovak | sl | Slovenian | | sq | Albanian | sr | Serbian | sv | Swedish | | sw | Swahili | th | Thai | tl | Tagalog (Filipino) | | tr | Turkish | uk | Ukrainian | ur | Urdu | | vi | Vietnamese | zh | Chinese (Simplified) | zh-Hant | Chinese (Traditional) |

positioninteger

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

mediastring[]

Array of media URLs to attach to the step (maximum 3)

Example request

{
  "guideId": "ioTkq4uNhy",
  "parentStepId": 123,
  "title": "Step Title",
  "choiceLabel": "Next",
  "content": "<p>This is the step content</p>",
  "media": [
    "https://example.com/image.png"
  ]
}

Response

Step successfully appended.

stepIdinteger

The ID of the newly created step.

Example response

{
  "stepId": 123456789
}

Changes

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