Skip to main content

v2.video.edit_video_info

POST /api/v2/video/edit_video_info

You need to call v2.media.init_video_upload, v2.media.upload_video_part, and v2.media.complete_video_upload to upload the video, and call the v2.media.get_video_upload_result to get the video_upload_id of uploaded video first, then call this API to set video post information. After submit, the video is still draft status, you need to call v2.video.post_video to post the video to Shopee Video. You can only set and update post information before the video is post.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/video/edit_video_info

Common Request Parameters

NameTypeSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
user_idint1Shopee's unique identifier for a user.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature generated by(depends on different APIs) partner_id, api path, timestamp, access_token, user_id and partner_key via HMAC-SHA256 hashing algorithm.

Request Parameters

NameTypeRequiredSampleDescription
video_upload_listobject[]TrueVideo information collection, no more than 5.
video_upload_idstringTruesg-11110199-6v99e-mgezdwct5eyya0ID of uploaded video. Obtain from v2.media.get_video_upload_result.
captionstringFalsethis is a test videoDescription of the Shopee Video.
cover_image_urlstringTruehttps://down-sg.img.susercontent.com/sg-11110199-6v99e-mgezdwct5eyya0\_pack\_v1\_1000001\_1Selected cover image url of the Shopee Video. Obtain from v2.video.get_cover_list.
item_infoobject[]FalseList of products to be linked with the Shopee Video, no more than 6.
item_idint64True2Shopee's unique identifier for an item.
custom_item_namestringFalseitem display nameProduct display name in Shopee Video.
allow_infoobjectTrueWhether allow stitch and duet.
allow_duetbooleanTruetrueWhether allow duet.
allow_stitchbooleanTruetrueWhether allow stitch.
scheduled_infoobjectTrueWhen scheduled_post is true, scheduled_post_time must not empty. When scheduled_post is false, scheduled_post_time must empty.
scheduled_postbooleanTruetrueWhether post it to Shopee Video at scheduled time.
scheduled_post_timetimestampFalse1761734929450Scheduled post time, millisecond timestamp. When scheduled_post is true, scheduled_post_time must not empty.

Response Parameters

NameTypeSampleDescription
errorstringIndicate error type if hit error. Empty if no error happened.
messagestringIndicate error details if hit error. Empty if no error happened.
request_idstring07af0e73-f806-4b09-af22-d28a72eae63aThe identifier for an API request for error tracking.
responseobjectDetail informations you are querying.
success_liststring[][ "sg-11110199-6v99e-mgezdwct5eyya0"]The list of video_upload_id edit successfully.
failure_listobject[]The list of video_upload_id edit failed.
fail_video_upload_idstringsg-11110199-6v99e-mgezdwct5eyya0Failed video_upload_id.
failed_reasonstringcan not edit video info,please retryFailed reason of the corresponding video_upload_id.