Update creative work

PATCH

cms

creative_works

{creative_work_id}

curl --request PATCH \
  --url https://api.mottostreaming.com/cms/creative_works/v1/{creative_work_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "creative_work_id": "<string>",
  "creative_work_update": {
    "project_id": "<string>",
    "type_id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "status": "CREATIVE_WORK_STATUS_UNSPECIFIED",
    "release_time": "2023-11-07T05:31:56Z",
    "thumbnail_asset_id": "<string>",
    "poster_asset_id": "<string>",
    "video_ids": [
      "<string>"
    ],
    "fields": {},
    "visibility": "VISIBILITY_UNSPECIFIED",
    "localized_title": {},
    "localized_description": {},
    "localized_thumbnail_asset_id": {},
    "localized_poster_asset_id": {}
  },
  "update_mask": "<string>"
}'

{
  "creative_work": {
    "id": "<string>",
    "project_id": "<string>",
    "type_id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "status": "CREATIVE_WORK_STATUS_UNSPECIFIED",
    "release_time": "2023-11-07T05:31:56Z",
    "thumbnail_asset_id": "<string>",
    "poster_asset_id": "<string>",
    "video_ids": [
      "<string>"
    ],
    "fields": {},
    "visibility": "VISIBILITY_UNSPECIFIED",
    "create_time": "2023-11-07T05:31:56Z",
    "localized_title": {},
    "localized_description": {},
    "localized_thumbnail_asset_id": {},
    "localized_poster_asset_id": {}
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

creative_work_id

string

required

Body

application/json

creative_work_id

string

required

creative_work_update

object

required

A creative work describes any kind of creative video content that does not have a start/end time (unlike an event).

creative_work_update.project_id

string

required

creative_work_update.type_id

string

The type id of the creative work. For example documentary. May be set to default when no custom fields are present.

creative_work_update.title

string

creative_work_update.description

string

creative_work_update.status

enum<string>

Current status of the creative work

Available options:

CREATIVE_WORK_STATUS_UNSPECIFIED,

CREATIVE_WORK_STATUS_SCHEDULED,

CREATIVE_WORK_STATUS_RELEASED

creative_work_update.release_time

string

The time at which this creative work was/will be released. This does not affect the visibility of the associated video(s), but can be displayed in the UI

creative_work_update.thumbnail_asset_id

string

creative_work_update.poster_asset_id

string

creative_work_update.video_ids

string[]

creative_work_update.fields

object

creative_work_update.visibility

enum<string>

Available options:

VISIBILITY_UNSPECIFIED,

VISIBILITY_PUBLISHED,

VISIBILITY_UNLISTED,

VISIBILITY_HIDDEN

creative_work_update.localized_title

object

A map of localized titles for this creative work, for end users to see. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the title field.

creative_work_update.localized_description

object

A map of localized descriptions for this creative work. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the description field.

creative_work_update.localized_thumbnail_asset_id

object

A map of localized thumbnail asset IDs for this creative work. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the thumbnail_asset_id field.

creative_work_update.localized_poster_asset_id

object

A map of localized poster asset IDs for this creative work. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the poster_asset_id field.

update_mask

string

Response

200

application/json

creative_work

object

A creative work describes any kind of creative video content that does not have a start/end time (unlike an event).

creative_work.project_id

string

required

creative_work.id

string

System generated unique identifier for the creative work.

creative_work.type_id

string

The type id of the creative work. For example documentary. May be set to default when no custom fields are present.

creative_work.title

string

creative_work.description

string

creative_work.status

enum<string>

Current status of the creative work

Available options:

CREATIVE_WORK_STATUS_UNSPECIFIED,

CREATIVE_WORK_STATUS_SCHEDULED,

CREATIVE_WORK_STATUS_RELEASED

creative_work.release_time

string

The time at which this creative work was/will be released. This does not affect the visibility of the associated video(s), but can be displayed in the UI

creative_work.thumbnail_asset_id

string

creative_work.poster_asset_id

string

creative_work.video_ids

string[]

creative_work.fields

object

creative_work.visibility

enum<string>

Available options:

VISIBILITY_UNSPECIFIED,

VISIBILITY_PUBLISHED,

VISIBILITY_UNLISTED,

VISIBILITY_HIDDEN

creative_work.create_time

string

creative_work.localized_title

object

Leaving this field empty will default to the title field.

creative_work.localized_description

object

Leaving this field empty will default to the description field.

creative_work.localized_thumbnail_asset_id

object

Leaving this field empty will default to the thumbnail_asset_id field.

creative_work.localized_poster_asset_id

object

Leaving this field empty will default to the poster_asset_id field.

Create creative work Delete creative work

curl --request PATCH \
  --url https://api.mottostreaming.com/cms/creative_works/v1/{creative_work_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "creative_work_id": "<string>",
  "creative_work_update": {
    "project_id": "<string>",
    "type_id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "status": "CREATIVE_WORK_STATUS_UNSPECIFIED",
    "release_time": "2023-11-07T05:31:56Z",
    "thumbnail_asset_id": "<string>",
    "poster_asset_id": "<string>",
    "video_ids": [
      "<string>"
    ],
    "fields": {},
    "visibility": "VISIBILITY_UNSPECIFIED",
    "localized_title": {},
    "localized_description": {},
    "localized_thumbnail_asset_id": {},
    "localized_poster_asset_id": {}
  },
  "update_mask": "<string>"
}'

{
  "creative_work": {
    "id": "<string>",
    "project_id": "<string>",
    "type_id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "status": "CREATIVE_WORK_STATUS_UNSPECIFIED",
    "release_time": "2023-11-07T05:31:56Z",
    "thumbnail_asset_id": "<string>",
    "poster_asset_id": "<string>",
    "video_ids": [
      "<string>"
    ],
    "fields": {},
    "visibility": "VISIBILITY_UNSPECIFIED",
    "create_time": "2023-11-07T05:31:56Z",
    "localized_title": {},
    "localized_description": {},
    "localized_thumbnail_asset_id": {},
    "localized_poster_asset_id": {}
  }
}

Get Started

Studio API

Content Delivery API

Deep dive

Update creative work

Authorizations

Path Parameters

Body

Response