Create or update an PortfolioCatalog

put https://api.sandbox.mozaic.io/api/portfolio/catalogs/{id}

Path Params

string

required

The id of the record you wish to retrieve

Query Params

ExternalId

string

The idea from the source third party

Title

string

The Title

Address.CommonName

string

Common name of the address like Central Park, If we already have this in our db, it will pick that address by default

Address.Address1

string

Address line 1

Address.Address2

string

Address line 2

Address.CityName

string

City name

Address.GeoPoint

string

Latitude and Longitude

Address.RegionId

int32

Address.PostalCode

string

Postal code or ZIP code

Address.RegionName

string

State, region or province

Address.CountryCode

string

Two-letter country code ISO 3166-1 alpha-2

Description

string

The decription

Details

object

A keyed list of other details related to the item
such as additional product details

Href

string

The external href (optional)

Type

string

The type of item audio, video, game, podcast, physical, location, destination, experience, tip-link, invoice

SubType

string

The type of item audio, video, game, podcast, physical, location, destination, experience, tip-link, invoice

Explicit

boolean

True if the content is deemd explicity, otherwise false

DurationMilliseconds

int32

Duration in ms

MinimumAgeRequirement

int32

Minimum age in years if there is an age requirement such as 18+, otherise null or zero

ExternalUrls

object

The external url

ExternalImages

array of objects

Collection of external images

ExternalImages

Attributions

array of objects

Attributions are the credits or roles attaching Contact items
to this PortfolioItem

Attributions

ImportExternalImages

boolean

When set to true Mozaic will import
the external images for the portfolio items
and raise an 'import_completed' shared event when complete

Headers

user_id

string

The user id to operate on their behalf (tenants only)

Responses

Language

Credentials


xxxxxxxxxx
1
curl --request PUT \
2
     --url 'https://api.sandbox.mozaic.io/api/portfolio/catalogs/id?Details=&ExternalUrls=' \
3
     --header 'accept: application/json'

Choose an example:

text/plain

application/json

text/json

200Success

400Bad Request

defaultError