API Reference

Update a story

put
https://partner-api.join-stories.com/v1/stories/

Updates a story and/or its widget attachments. A containers-only PUT (no pages / title) does not regenerate the story. Publish is fire-and-forget: 200 means the story was persisted and publish started, not that every widget is live. Update can take up to 360s; use a client timeout ≥ 360s for hundreds of aliases. productPages and removeProductPages live under widgets[alias], not at the root.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Widgets absent from widgets are disassociated. An unknown alias is created when widgetPresetAlias is provided (entry or request default).

Path Params
string
required

The ID of the story to update.

Body Params
string

(Optional) Update the label of all widgets.

string

(Optional) Update story title. Omit together with pages for a containers-only PUT (no story regeneration).

widgets
object

(Optional) Dictionary of widgets. Widgets absent from this object are disassociated. Unknown alias + widgetPresetAlias creates the widget. Each alias may include widgetOrder, order (product-page association, not widgetOrder), productPages, removeProductPages, audiences, schedule, widgetCoverMediaId, widgetPresetAlias, widgetLabel.

pages
array of objects

If sent, must contain at least one page. Regenerates the story. Omit for a containers-only update.

pages
Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?