HomeGuidesAPI Reference
API Reference

Create Stream

post
https://v2.api.uberflip.com/streams

Creates a "from scratch" Blog Stream, a Marketing Stream, or a Sales Stream.

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

Specifies the ID code for the target Hub

string
enum
required

Specifies the type of Stream to be created. See the table below for available values.
Can use these values with the service body parameter:

  • blogpost: Creates a "from scratch" Blog Stream (a Blog Stream that does not pull in posts from an external RSS feed)
  • custom: Creates a Marketing Stream
  • targeted: Creates a Sales Stream
Allowed:
string
required

Specifies the title to use for the created Stream

string

Specifies the name to set for the created Stream (if not provided, name is set with title value)

string

Specifies the description to set for the created Stream

string

Specifies the SEO title for the created Stream

string

Specifies the SEO description for the created Stream

string

Specifies the thumbnail URL for the created Stream

service_data
object

An object containing params which define various Stream options.

string

External ID of Stream (custom)

string

External mode of Stream (custom)

string

External service of Stream (custom)

string

Specify whether the created Stream should be muted. Specifying true will mute the Stream (custom)

boolean

Specify whether the created Stream should be hidden. Specifiying true will hide the Stream. (blogpost, custom)

boolean
Defaults to false

Specify whether the created Stream should be paused. Specifiying true will pause the Stream.

boolean
Defaults to false

Specify whether Items in the Stream will be excluded from Hub Search results. Specifying true will exclude Items in the Stream from search results. (blogpost, custom)

boolean
Defaults to false

DESCRIPTION HERE (blogpost, custom)

boolean
Defaults to true

Specify whether the Stream is visible in shout

boolean
Defaults to false

Specify whether the Stream is pinned in shout

boolean
Defaults to false

Specify whether to hide the publish date of the Stream

boolean
Defaults to false

Specify whether to enable preview mode for Stream

integer

ID of the template set for Stream. Defaults to 1 if type == custom and no value is provided (targeted, custom)

integer

ID of the purpose set for Stream (targeted, custom)

Response

Updated over 3 years ago

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

Updated over 3 years ago

x