API Reference

Add an album to a site

post
https://platform.{env}.simpplr.com/v1/content/sites//album

This API allows us to add an album to a site

Path Params
string
required

The ID of the site to add an album to

Query Params
string
enum
required

The action to perform on the album

Allowed:
Body Params
listOfFiles
array of objects

Array of file attachments

listOfFiles
date-time

Date and time when the album should be published (required when publishingStatus is 'schedule'). Must be in ISO 8601 UTC format

string | null

URL of the landscape image

date-time | null

Date and time when the content should expire/unpublish. Must be in ISO 8601 UTC format

string
required

Main content of the album in HTML format

string
enum
required

Publishing status of the album

Allowed:
string
enum

Layout style for the featured image

Allowed:
string | null

Caption for the featured image

uuid | null

UUID of the landscape image file

string
required
length ≤ 255

Title of the album

boolean

Whether to use maximum width layout

boolean

Whether the album appears in feeds

boolean

Whether question and answer feature is enabled

boolean

Whether the content is restricted to specific audiences

targetAudience
array of uuids
length ≥ 0

List of UUIDs identifying the target audiences

targetAudience
listOfTopics
array of objects | null

Array of topics associated with the album

listOfTopics
string | null

Summary of the album content

listOfAlbumMedia
array of objects
required
length ≥ 1

Array of media items in the album

listOfAlbumMedia*
string
required

Media ID

string | null

Description of the media

string | null

Alternative text for the media

string

File ID

string
enum

Provider of the media file

Allowed:
string

Name of the media file

string

Type of the media file

string

Size of the media file

string

URL of the thumbnail

number

Version of the media file

number

Status of the video if applicable

boolean

Whether the album is open to submissions

string
required

ID of the media item to use as cover image

string

Language of the album content

Responses

Updated 4 months ago

Language
Credentials
OAuth2
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago