buttons
Add a navigation button
/api/v1/steps/{step_id}/buttons
Add a button to a step of the draft. link says where it leads:
to_newcreates a step namedreferenceand points at it;to_existpoints at the existing step namedreference;to_endends the flow.
key
Required scope: write
Path parameters
-
step_idinteger · requiredId of the step.
Request body application/json
-
labelstring · requiredWhat the button says.
-
linkstring · requiredto_new: create a step and point at it.to_exist: point at an existing step.to_end: end the flow. -
referencestring or null · optionalReference of the target step: the one to create (
to_new) or the existing one (to_exist). Unused forto_end.
Response
201
Button
-
idintegerId of the button.
-
labelstringWhat the button says.
-
target_step_idinteger or nullId of the step it leads to;
nullwhen it ends the flow, or when its target was deleted. -
target_referencestringReference of the step it leads to, kept after that step is deleted; empty when it ends the flow.
-
ends_procedurebooleanWhether it ends the flow.
-
target_missingbooleanWhether 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-Aftergives the seconds to wait.