Contents x
    Update a video by customerVideoId
      • Print
      Contents

      Update a video by customerVideoId

        • Print
        Article summary

        Put
        /v2/{accessKey}/video/customerVideoId/{customerVideoId}

        You can change the title, description, and tags of a video using customerVideoId

        Header parameters
        Authorization
        stringRequired

        Authorization: Bearer

        Path parameters
        accessKey
        stringRequired

        Customer access key

        customerVideoId
        stringRequired

        Target customerVideoId to update meta data

        Body parameters
        example

        Example of Body

        {
  "title": "Updated title",
  "description": "Updated description",
  "tags": [
    "tag1",
    "tag2",
    "tag3"
  ]
}
        object
        title
        string

        Title of the video. max. 255 characters. If not specified, default value is original filename.

        description
        string

        Description of the video. max. 65535 characters.

        tags
        Array of string

        Tags in array form(max 10 tags)

        string
        Responses
        200

        200

        Result
        "{\n    \"videoId\": \"100\",\n    \"customerVideoId\": \"SHOPLIVE_VIDEO_1\",\n    \"title\": \"Updated Shoplive Introduction Video\",\n    \"description\": \"Description is updated\",\n    \"tags\":[\"tag1\"],\n    \"filename\": \"shoplive_introduction_video.mp4\",\n    \"width\": 1080,\n    \"height\": 1920,\n    \"filesize\": \"38128539\",\n    \"videoSourceUrl\": \"https://resource.shoplive.cloud/videos/vod/archive/{accessKey}/{streamKey}.mp4\",\n    \"thumbnailImageUrl\": \"https://image.shoplive.cloud/{streamKey}.jpg\",\n    \"liveStreamUrl\": \"https://api.shoplive.cloud/v1/videos/{accessKey}/rt_1240.m3u8\",\n    \"liveStreamUrls\": \"https://api.shoplive.cloud/v1/videos/{accessKey}/rt_1240/320p.m3u8\",\n    \"vodStreamUrl\": \"https://resource.shoplive.cloud/videos/vod/hls/{streamKey}.m3u8\",\n    \"vodStreamUrls\": \"https://resource.shoplive.cloud/videos/vod/hls/{streamKey}_320p/index.m3u8\",\n    \"duration\": 202000,\n    \"uploadProgress\": 100,\n    \"createdAt\": \"2022-12-09T09:17:04Z\",\n      \"updatedAt\": \"2022-12-09T09:17:04Z\"\n      \n}"
        object
        videoId
        string
        Example100
        customerVideoId
        string
        ExampleSHOPLIVE_VIDEO_1
        title
        string
        ExampleUpdated Shoplive Introduction Video
        description
        string
        ExampleDescription is updated
        tags
        Array of string
        string
        Exampletag1
        filename
        string
        Exampleshoplive_introduction_video.mp4
        width
        integer
        Default0
        Example1080
        height
        integer
        Default0
        Example1920
        filesize
        string
        Example38128539
        videoSourceUrl
        string
        Examplehttps://resource.shoplive.cloud/videos/vod/archive/{accessKey}/{streamKey}.mp4
        thumbnailImageUrl
        string
        Examplehttps://image.shoplive.cloud/{streamKey}.jpg
        liveStreamUrl
        string
        Examplehttps://api.shoplive.cloud/v1/videos/{accessKey}/rt_1240.m3u8
        liveStreamUrls
        string
        Examplehttps://api.shoplive.cloud/v1/videos/{accessKey}/rt_1240/320p.m3u8
        vodStreamUrl
        string
        Examplehttps://resource.shoplive.cloud/videos/vod/hls/{streamKey}.m3u8
        vodStreamUrls
        string
        Examplehttps://resource.shoplive.cloud/videos/vod/hls/{streamKey}_320p/index.m3u8
        duration
        integer
        Default0
        Example202000
        uploadProgress
        integer
        Default0
        Example100
        createdAt
        string
        Example2022-12-09T09:17:04Z
        updatedAt
        string
        Example2022-12-09T09:17:04Z
        4XX

        4XX

        Result
        "{\n    \"_s\": -000,\n    \"_e\": \"Error message\"\n}"
        What's Next