Skip to main content
API docs by Redocly

StoryPRO API (params in:body) (1.2)

Download OpenAPI specification:Download

StoryPRO API documentation

© 2023 StoryPRO

articles

Retrieves an existing article.

This endpoint is used to retrieve an existing article.

Authorizations:
ApiKeyAuth
path Parameters
id
required
number

Responses

Updates an existing article.

This endpoint is used to update an existing article.

  • Fields description, landscape_image, card_image and image_alt are required unless specified during the creation of the article.
  • Additional fields, such as filter can be passed by adding them as a parameter to the article hash.
  • See /articles/new endpoint for a list of all available fields.
Authorizations:
ApiKeyAuth
path Parameters
id
required
number
Request Body schema: application/json
required
object
tags
Array of strings
Default: [1,2]

The array of tag ids (Integers) associated with the article

Responses

Request samples

Content type
application/json
{}

Deletes an existing article.

This endpoint is used to delete an existing article.

Authorizations:
ApiKeyAuth
path Parameters
id
required
number

Responses

Retrieves a set of fields to create a new article.

This endpoint is used to retrieve a set of fields to create a new article.

Authorizations:
ApiKeyAuth

Responses

Creates a new article.

This endpoint is used to create a new article.

  • At minimum the fields name, user_id and category_id are required.
  • Additional fields, such as description, can be passed by adding them as a parameter to the article hash.
  • See articles/new endpoint for a list of all available fields.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object
name
required
string
Default: "New Entry"

The name of the entry

user_id
required
number
Default: 1

The User ID of the author

category_id
required
number
Default: 1

The Category ID of the entry

Responses

Request samples

Content type
application/json
{
  • "article": {
    }
}

entries

Retrieve entry details.

Retrieves an array of entries, along with their categories, tags and published status.

Authorizations:
ApiKeyAuth
query Parameters
kind
string
Enum: "article" "video" "discussion" "promotion"

Allows you to filter the kind of entries you are going to retrieve

status
string
Default: "all"
Enum: "all" "published" "unpublished" "scheduled"

Allows you to filter off the entries' published status

Responses

categories

Retrieves a list of categories.

Authorizations:
ApiKeyAuth

Responses

Creates a new category.

This endpoint is used to create a new category.

  • At minimum the fields name and color_id are required.
  • Additional fields can be passed by adding them as a parameter to the category hash.
  • See /categories/new endpoint for a list of all available fields.
  • See /colors/ endpoint for a list of all available colors.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object
name
string
Default: "New Category"

The name of the category

color_id
number
Default: 1

The ID of the color associated with the category

Responses

Request samples

Content type
application/json
{
  • "category": {
    }
}

Retrieves an existing category.

This endpoint is used to retrieve an existing category.

Authorizations:
ApiKeyAuth
path Parameters
id
required
number

Responses

Updates an existing category.

This endpoint is used to update an existing category.

  • Additional fields can be passed by adding them as a parameter to the category hash.
  • See categories/new endpoint for a list of all available fields.
  • See /colors/ endpoint for a list of all available colors.
Authorizations:
ApiKeyAuth
path Parameters
id
required
number
Request Body schema: application/json
required
object
name
string
Default: "New Category"

The name of the category

color_id
number
Default: 1

The ID of the color associated with the category

Responses

Request samples

Content type
application/json
{
  • "category": {
    }
}

Deletes an existing category.

This endpoint is used to delete an existing category.

Authorizations:
ApiKeyAuth
path Parameters
id
required
number

Responses

Retrieves a set of fields to create a new category.

This endpoint is used to retrieve a set of fields to create a new category.

Authorizations:
ApiKeyAuth

Responses

colors

Retrieves color names along with their IDs.

Retrieves a list of colors names and their IDs.

Authorizations:
ApiKeyAuth

Responses

discussions

Retrieves an existing discussion.

This endpoint is used to retrieve an existing discussion.

Authorizations:
ApiKeyAuth
path Parameters
id
required
number

Responses

Updates an existing discussion.

This endpoint is used to update an existing discussion.

  • Field description is required unless specified during the creation of the discussion.
  • Additional fields, such as social_image can be passed by adding them as a parameter to the discussion hash.
  • See discussions/new endpoint for a list of all available fields.
Authorizations:
ApiKeyAuth
path Parameters
id
required
number
Request Body schema: application/json
required
object
tags
Array of strings
Default: [1,2]

The array of tag ids (Integers) associated with the discussion

Responses

Request samples

Content type
application/json
{
  • "discussion": {
    },
  • "tags": [
    ]
}

Deletes an existing discussion.

This endpoint is used to delete an existing discussion.

Authorizations:
ApiKeyAuth
path Parameters
id
required
number

Responses

Retrieves a set of fields to create a new discussion.

This endpoint is used to retrieve a set of fields to create a new discussion.

Authorizations:
ApiKeyAuth

Responses

Creates a new discussion.

This endpoint is used to create a new discussion.

  • At minimum the fields name, user_id and category_id are required.
  • Additional fields, such as description can be passed by adding them as a parameter to the discussion hash.
  • See discussions/new endpoint for a list of all available fields.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object
name
required
string
Default: "New Entry"

The name of the entry

user_id
required
number
Default: 1

The User ID of the author

category_id
required
number
Default: 1

The Category ID of the entry

Responses

Request samples

Content type
application/json
{
  • "discussion": {
    }
}

elements

Returns a list of all elements.

Authorizations:
ApiKeyAuth
query Parameters
type
string
Default: "elements_blockquote"

The type of the element to filter by

Responses

Returns an array of distinct elements.

Authorizations:
ApiKeyAuth

Responses

Adds an element to an area of an entry.

this endpoint is used to create a new element.

  • See elements/distinct endpoint for a list of all available elements.
  • The elements must be created and attached to an AREA of a PARENT COMPONENT, BEFORE it can be edited.
  • The PARENT ID is the ID of the entry the element is attached to.
  • Areas header, content and reference are available for articles, videos, discussions and promotions parent component.
  • Area homepage is available for site_settings_theme_homepage parent component.
  • Areas page, fullscreen, regular and featured are available for site_settings_theme_css parent component.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
element
required
string
Default: "elements_blockquote"

The name of element to add. Dont forget the elements_ prefix

parent_id
required
number
Default: 1

Parent ID of the component the element is attached to.

parent_component
required
string
Default: "articles"
Enum: "articles" "videos" "discussions" "promotions" "site_settings_theme_css" "site_settings_theme_homepage"

Parent component the element is attached to.

area
required
string
Enum: "header" "content" "reference" "homepage" "page" "fullscreen" "regular" "featured"

The area of the element.

Responses

Request samples

Content type
application/json
{
  • "element": "elements_blockquote",
  • "parent_id": 1,
  • "parent_component": "articles",
  • "area": "header"
}

Updates an existing element.

  • This endpoint is used to update an existing element.
  • The request must be wrapped in an element object such elements_blockquote representing the element to be updated.
  • Fields such author must be nested inside the wrapper object.
  • See elements/distinct endpoint for a list of all available elements and their fields.
Authorizations:
ApiKeyAuth
path Parameters
id
required
number
Request Body schema: application/json
object
object
Default: "John Cena"

The field object to be updated

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "element_blockquote": {
    }
}

Deletes an existing article.

This endpoint is used to delete an existing article.

Authorizations:
ApiKeyAuth
path Parameters
id
required
number

Responses

promotions

Retrieves an existing promotion.

This endpoint is used to retrieve an existing promotion.

Authorizations:
ApiKeyAuth
path Parameters
id
required
number

Responses

Updates an existing promotion.

This endpoint is used to update an existing promotion.

  • title, text and image are required unless specified during the creation of the promotion.
  • Additional fields, such as new_window can be passed by adding them as a parameter to the promotion hash.
  • See promotions/new endpoint for a list of all available fields.
Authorizations:
ApiKeyAuth
path Parameters
id
required
number
Request Body schema: application/json
required
object
title
string
Default: "Promotion Title"

Title of the promotion

text
string
Default: "Promotion Description"

Body text of the promotion

image
string
Default: "https://ucarecdn.com/.../"

Image displayed in background of promotion. Formatted for 1111x1111 resolution

Responses

Request samples

Content type
application/json
{}

Deletes an existing promotion.

This endpoint is used to delete an existing promotion.

Authorizations:
ApiKeyAuth
path Parameters
id
required
number

Responses

Retrieves a set of fields to create a new promotion.

This endpoint is used to retrieve a set of fields to create a new promotion.

Authorizations:
ApiKeyAuth

Responses

Creates a new promotion.

This endpoint is used to create a new promotion.

  • At minimum the fields name and url are required.
  • Additional fields, such as title or description, can be passed by adding them as a parameter to the promotion hash.
  • See /promotions/new endpoint for a list of all available fields.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object
tags
Array of strings
Default: [1,2]

The array of tag ids (Integers) associated with the promotion

Responses

Request samples

Content type
application/json
{}

settings

Retrieves individual platform settings.

Retrieves individual platform settings.

Authorizations:
ApiKeyAuth

Responses

tags

Retrieves a list of tags.

This endpoint is used to retrieve a list of tags.

Authorizations:
ApiKeyAuth

Responses

Creates a new tag.

This endpoint is used to create a new tag.

  • At minimum the field name is required.
  • Additional fields, such as promotion_only, can be passed by adding them as a parameter to the tag hash.
  • See /tags/new endpoint for a list of all available fields.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object
name
required
string
Default: "My tag"

The name of the tag

promotion_only
string
Enum: true false "true" "false"

Set to true if you don't want the tag to be used for linking content.

Responses

Request samples

Content type
application/json
{
  • "tag": {
    }
}

Retrieves an existing tag.

This endpoint is used to retrieve an existing tag.

Authorizations:
ApiKeyAuth
path Parameters
id
required
number

Responses

Updates an existing tag.

This endpoint is used to update an existing tag.

  • Additional fields, such as promotion_only, can be passed by adding them as a parameter to the tag hash.
  • See /tags/new endpoint for a list of all available fields.
Authorizations:
ApiKeyAuth
path Parameters
id
required
number
Request Body schema: application/json
required
object
name
required
string
Default: "My tag"

The name of the tag

promotion_only
string
Enum: true false "true" "false"

Set to true if you don't want the tag to be used for linking content.

Responses

Request samples

Content type
application/json
{
  • "tag": {
    }
}

Deletes an existing tag.

This endpoint is used to delete an existing tag.

Authorizations:
ApiKeyAuth
path Parameters
id
required
number

Responses

Retrieves a set of fields to create a new tag.

This endpoint is used to retrieve a set of fields to create a new tag.

Authorizations:
ApiKeyAuth

Responses

users

Retrieve user details.

Retrieves an array of users, along with their role.

Authorizations:
ApiKeyAuth
query Parameters
role
string
Enum: "admin" "editor" "member" "banned"

Allows you to filter the role of users you are going to retrieve

Responses

videos

Retrieves an existing video.

This endpoint is used to retrieve an existing video.

Authorizations:
ApiKeyAuth
path Parameters
id
required
number

Responses

Updates an existing video.

This endpoint is used to update an existing video.

  • Fields description, landscape_image, card_image and image_alt are required unless specified during the creation of the video.
  • Additional fields, such as filter can be passed by adding them as a parameter to the video hash.
  • See videos/new endpoint for a list of all available fields.
Authorizations:
ApiKeyAuth
path Parameters
id
required
number
Request Body schema: application/json
required
object
tags
Array of strings
Default: [1,2]

The array of tag ids (Integers) associated with the video

Responses

Request samples

Content type
application/json
{}

Deletes an existing video.

This endpoint is used to delete an existing video.

Authorizations:
ApiKeyAuth
path Parameters
id
required
number

Responses

Retrieves a set of fields to create a new video.

This endpoint is used to retrieve a set of fields to create a new video.

Authorizations:
ApiKeyAuth

Responses

Creates a new video.

This endpoint is used to create a new video.

  • At minimum the fields name, user_id and category_id are required.
  • Additional fields, such as description can be passed by adding them as a parameter to the video hash.
  • See /videos/new endpoint for a list of all available fields.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object
name
required
string
Default: "New Entry"

The name of the entry

user_id
required
number
Default: 1

The User ID of the author

category_id
required
number
Default: 1

The Category ID of the entry

Responses

Request samples

Content type
application/json
{
  • "video": {
    }
}