buttons
Edit a navigation button
/api/v1/buttons/{button_id}
Change the label of a button, its target, or both. A target is given as on creation, with link and reference.
key
Required scope: write
Path parameters
-
button_idinteger · requiredId of the navigation button.
Request body application/json
-
labelstring or null · optionalNew label.
-
linkstring or null · optionalNew kind of target, as on creation. Left out: the button keeps the kind it has.
-
referencestring or null · optionalReference of the new target step.
Response
200
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.