Set main preview

PUT /actions/preview-files/{preview_file_id}/set-main-preview

Set given preview as main preview of the related entity. This preview will be used to illustrate the entity.

Path parameters

  • preview_file_id string(uuid) Required

    Preview file unique identifier

Query parameters

  • frame_number integer

    Frame number for movie previews

Responses

  • 200 application/json

    Preview set as main preview

    Hide response attributes Show response attributes object
    • id string(uuid)

      Entity unique identifier

    • preview_file_id string(uuid)

      Preview file unique identifier

  • 400

    Cannot use frame number on non-movie preview

PUT /actions/preview-files/{preview_file_id}/set-main-preview
curl \
 --request PUT 'http://api.example.com/actions/preview-files/a24a6ea4-ce75-4665-a070-57453082c25/set-main-preview' \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "preview_file_id": "b35b7fb5-df86-5776-b181-68564193d36"
}