Update a shortform

    Update a shortform


    Article summary

    Put
    /v2/{accessKey}/shortform/{shortformId}
    Header parameters
    Authorization
    stringRequired

    Authorization: Bearer

    Path parameters
    accessKey
    stringRequired

    Customer access key

    shortformId
    integer (int64) Required

    shortformId

    Body parameters
    example

    Example of Body

    {
      "status": "SCHEDULED",
      "details": {
        "title": "Shortform updated by V2 API-2 sample",
        "description": "Description of shortform",
        "scheduledOpenAt": "2025-05-29T09:11:49Z",
        "scheduledCloseAt": "2025-06-30T09:11:49Z",
        "brand": {
          "brandId": 1369
        },
        "tags": [
          "Shortform",
          "V2",
          "API",
          "Updated"
        ]
      },
      "video": {
        "videoId": 4107678627507208193
      }
    }
    Expand All
    object
    details
    object
    title
    string

    Title of the shortform

    description
    string

    Description of the shortform

    tags
    string

    Tag information set to the shortform (Max 5 tags can be set)

    brand
    object
    brandId
    integer (int64)

    Brand ID

    products
    Array of object
    object
    productId
    integer (int64)

    product ID

    customerProductId
    string

    customer product ID

    scheduledStartAt
    string

    OffsetDateTime(YYYY-MM-DD'T'HH:mm:ss'Z', UTC format only)

    scheduledEndAt
    string

    OffsetDateTime(YYYY-MM-DD'T'HH:mm:ss'Z', UTC format only)

    seller
    object
    sellerId
    integer (int64)

    Seller ID

    video
    object
    videoId
    integer (int64)

    video ID

    customerVideoId
    string

    customer video ID

    status
    string

    status of the shortform: OPEN|HIDDEN|SCHEDULED

    Responses
    200

    200

    Result
    "{\n    \"shortformId\" : \"123456789012345678\",\n    \"createdAt\" : \"2023-12-25T08:00:00Z\", \n    \"updatedAt\" : \"2023-12-26T08:00:00Z\",\n    \"status\" : \"OPEN\",\n    \"details\" : {\n      \"title\" : \"Shortform Title\",\n      \"description\" : \"This is a sample description\",\n      \"brand\" : {\n        \"id\" : 123,\n        \"identifier\" : \"shoplive\", \n        \"name\" : \"Shoplive\",\n        \"imageUrl\" : \"https://image.shoplive.cloud/brand-image.png\"\n      },\n      \"tags\" : [ \"food\", \"snack\" ],\n      \"productCount\" : 3,\n      \"productBanner\" : {\n        \"title\" : \"Product Banner Title\",\n        \"imageUrl\" : \"https://image.shoplive.cloud/product-banner-image.png\",\n        \"scheme\": \"https://www.shoplive.cloud/product\" \n      },\n      \"products\" : [ {\n        \"productId\" : 54321,\n        \"name\" : \"Shoelive T-shirts\",\n        \"brand\" : \"Shoplive Brand\",\n        \"url\" : \"https://shoplivedemo.com/product/54321\",\n        \"sku\" : \"sku001\",\n        \"imageUrl\" : \"https://image.shoplive.cloud/product-image.png\",\n        \"currency\" : \"KRW\",\n        \"showPrice\" : true,\n        \"originalPrice\" : 3400.0,\n        \"discountPrice\" : 2500.0,\n        \"discountRate\" : 26.0,\n        \"stockStatus\" : \"IN_STOCK\"\n      } ]\n    },\n    \"activity\" : {\n      \"viewCount\" : 2345,\n      \"likeCount\" : 123,\n      \"commentCount\" : 123,\n      \"bookmarkCount\" : 123,\n\t\t\t\"shareCount\" : 321\n    },\n    \"video\" : [ {\n      \"duration\" : 3600,\n      \"videoId\" : \"1234\",\n      \"videoUrl\" : \"https://resource.shoplive.cloud/video/shortsform/video.m3u8\",\n      \"previewVideoUrl\" : \"https://resource.shoplive.cloud/video/shortsform/previewVideo.m3u8\",\n      \"screenshotUrl\" : \"https://image.shoplive.cloud/shortform/screenshot.png\"\n    } ],\n}"
    4XX

    4XX

    Result
    "{\n    \"_s\": -000,\n    \"_e\": \"Error message\"\n}"