API Reference

Update an album in a site

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

This API allows us to update an existing album in a site

Path Params
string
required

The ID of the site containing the album

string
required

The ID of the content/album to update

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 content 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
enum

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
length ≤ 255

Title of the album

string

Main content of the album in HTML format

boolean

Whether to use maximum width layout

boolean

Whether the album appears in feeds

boolean

Whether the content is restricted to specific audiences

targetAudience
array of uuids
length ≥ 0

List of UUIDs identifying the target audiences

targetAudience
boolean

Whether question and answer feature is enabled

listOfTopics
array of objects | null

Array of topics associated with the album

listOfTopics
string | null

Summary of the album content

listOfAlbumMedia
array of objects
length ≥ 1

Array of media items in the album

listOfAlbumMedia
string
required

Media item ID

string | null

Description of the media item

string | null

Alternative text for the media item

string

File ID of the media item

string
enum

Provider of the media item

Allowed:
string

Name of the media item

string

Type of the media item

string

Size of the media item

string

Thumbnail URL of the media item

number

Version of the media item

number

Video processing status

boolean

Whether the album is open to submissions

string

ID of the cover image media

string

Language of the content

Responses

Updated 4 months ago

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

Updated 4 months ago