API Reference

Create a story

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

The createStory method returns the storyId and the final alias of the widget. The returned alias may differ from the one provided in the request, as it undergoes normalization (e.g., removal of special characters).

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

Omit elements in a template

Only elements explicitly provided in pages[].elements (by keyName matching the template element’s name) are instantiated. If an element is omitted, it is not added to the final page.

Body Params
string
required

This is the alias of the widget to which the story will be added.

string
required

If the widgetAlias does not exist, this preset widget will be used for new widget creation, and its settings will be copied.

string
required

This is the widget label for the story. It will be displayed beneath the story bubble

pages
array of objects
required
pages*
string
required

This is the ID of the uploaded media that will be used as the widget cover for this story.

string
required

This is the title of the story. It won't be displayed to the end user, but will be used for managing your stories.

string
Defaults to false

Controls whether existing stories are retained when a widget preset is applied.

schedule
object

Optional : key use to schedule when the story should be added or removed from the widget.

audiences
array of objects

Optional: Key used to insert the newly created story into an audience slot. This operation cannot be performed if the destination widget does not exist. Important: Please contact the JOIN team to obtain the required IDs before using this field.

audiences
Responses

Updated 3 months ago

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

Updated 3 months ago