Create Stream¶
This endpoint creates and returns the details of a stream.
Request¶
POST https://v2.api.uberflip.com/streams
Body Parameters | Properties | Type | Description |
---|---|---|---|
hub_id | Integer | The hub identifier | |
title | String | The stream title | |
description | String | The stream description | |
service | String | The service that the stream imports items from
|
|
no_robots | Boolean | Whether the stream allows robots | |
template_data | Object | ||
-> | list_view | Boolean | Whether the stream is in list view |
-> | read_more | Boolean | Whether the stream has the read more button |
-> | prevent_small_images | Boolean | Whether the stream allows small images |
-> | canonical_meta | Boolean | Whether the stream has canonical meta |
-> | canonical_redirect | Boolean | Whether the stream has canonical redirect |
-> | comments_disabled | Boolean | Whether the stream allows comments |
hidden | Boolean | Whether the stream is hidden | |
paused | Boolean | Whether the stream is paused | |
exclude_from_search | Boolean | Whether the stream is excluded from search |
Response¶
Body Parameters | Properties | Type | Description |
---|---|---|---|
id | Integer | The stream identifier | |
hub_id | Integer | The hub identifier | |
title | String | The stream title | |
description | String | The stream description | |
url | String | The stream URL | |
thumbnail_url | String | The stream thumbnail URL | |
type | String | The type of stream (“blogs”, “docs”, “videos”, etc) | |
service | String | The service that the stream imports items from (“blogpost”, “uberflip”, “youtube”, “vimeo”, etc) | |
item_count | Integer | The number of items in the stream | |
no_robots | Boolean | Whether the stream allows robots | |
template_data | Object | ||
-> | list_view | Boolean | Whether the stream is in list view |
-> | read_more | Boolean | Whether the stream has the read more button |
-> | prevent_small_images | Boolean | Whether the stream allows small images |
-> | canonical_meta | Boolean | Whether the stream has canonical meta |
-> | canonical_redirect | Boolean | Whether the stream has canonical redirect |
-> | comments_disabled | Boolean | Whether the stream allows comments |
owner | Object | ||
-> | id | Integer | Id of the user that created this stream |
-> | first_name | String | First name of the user that created this stream |
-> | last_name | String | Last Name of the user that created this stream |
-> | avatar_url | String | Url of this user’s avatar image |
hidden | Boolean | Whether the stream is hidden | |
paused | Boolean | Whether the stream is paused | |
exclude_from_search | Boolean | Whether the stream is excluded from search | |
created_at | Date | The stream created date | |
modified_at | Date | The stream last modified date |
Examples¶
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer [Token]" -d "{ \
\"hub_id\": 24601, \
\"title\": \"Relevantize Blog\", \
\"description\": null, \
\"service\": \"blog\" }" \
-i https://v2.api.uberflip.com/streams
Sample response:
HTTP/1.1 201 CREATED
Content-Type: application/json
{
"id": 17359,
"hub_id": 24601,
"title": "Relevantize Blog",
"description": null,
"url": null,
"thumbnail_url": "http://cdn.uberflip.com/mediaproxy?url=https://content.cdntwrk.com/files/aHViPTIxOCZjbWQ9aXRlbWVkaXRvcmltYWdlJmZpbGVuYW1lPWl0ZW1lZGl0b3JpbWFnZV81NjQyNGE5OWExODUwLnBuZyZ2ZXJzaW9uPTAwMDAmc2lnPWMyYjg3NTQ4YWU3NjJhODAxYjM4NWY1NGE0NWZiMGEx&size=3&version=14471",
"service": "blogpost",
"no_robots": true,
"template_data": {
"list_view": false,
"read_more": true,
"prevent_small_images": true,
"canonical_meta": true,
"canonical_redirect": false,
"comments_disabled": true
},
"hidden": false,
"paused": true,
"exclude_from_search": false,
"created_at": "2013-06-14T14:13:41-0400",
"modified_at": "2015-11-11T09:38:45-0500"
}