Update file detail
curl --request PUT \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"file_name": "<string>",
"title": "<string>",
"alternate_text": "<string>",
"description": "<string>",
"meta_data": [
{
"key": "<string>",
"value": "<string>"
}
],
"tags": [
"<string>"
],
"folder_id": "<string>"
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id}"
payload = {
"file_name": "<string>",
"title": "<string>",
"alternate_text": "<string>",
"description": "<string>",
"meta_data": [
{
"key": "<string>",
"value": "<string>"
}
],
"tags": ["<string>"],
"folder_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
file_name: '<string>',
title: '<string>',
alternate_text: '<string>',
description: '<string>',
meta_data: [{key: '<string>', value: '<string>'}],
tags: ['<string>'],
folder_id: '<string>'
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'file_name' => '<string>',
'title' => '<string>',
'alternate_text' => '<string>',
'description' => '<string>',
'meta_data' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'tags' => [
'<string>'
],
'folder_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id}"
payload := strings.NewReader("{\n \"file_name\": \"<string>\",\n \"title\": \"<string>\",\n \"alternate_text\": \"<string>\",\n \"description\": \"<string>\",\n \"meta_data\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"folder_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"file_name\": \"<string>\",\n \"title\": \"<string>\",\n \"alternate_text\": \"<string>\",\n \"description\": \"<string>\",\n \"meta_data\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"folder_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"file_name\": \"<string>\",\n \"title\": \"<string>\",\n \"alternate_text\": \"<string>\",\n \"description\": \"<string>\",\n \"meta_data\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"folder_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"file": {
"id": "<string>",
"file_name": "<string>",
"file_extension": "<string>",
"file_size": 123,
"file_type": "image",
"mime_type": "<string>",
"title": "<string>",
"alternate_text": "<string>",
"description": "<string>",
"meta_data": [
{
"key": "<string>",
"value": "<string>"
}
],
"tags": [
"<string>"
],
"folder_id": "<string>",
"upload_source": "local-storage",
"status": "ready",
"usage": [
{
"used_in": "product",
"used_in_reference_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"external_url": "<string>",
"url": {
"image_original": "<string>",
"image_standard": "<string>",
"image_thumbnail": "<string>",
"image_blur": "<string>"
}
}
}
}Media Gallery
Update file detail
Update file detail
PUT
/
media
/
files
/
{id}
Update file detail
curl --request PUT \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"file_name": "<string>",
"title": "<string>",
"alternate_text": "<string>",
"description": "<string>",
"meta_data": [
{
"key": "<string>",
"value": "<string>"
}
],
"tags": [
"<string>"
],
"folder_id": "<string>"
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id}"
payload = {
"file_name": "<string>",
"title": "<string>",
"alternate_text": "<string>",
"description": "<string>",
"meta_data": [
{
"key": "<string>",
"value": "<string>"
}
],
"tags": ["<string>"],
"folder_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
file_name: '<string>',
title: '<string>',
alternate_text: '<string>',
description: '<string>',
meta_data: [{key: '<string>', value: '<string>'}],
tags: ['<string>'],
folder_id: '<string>'
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'file_name' => '<string>',
'title' => '<string>',
'alternate_text' => '<string>',
'description' => '<string>',
'meta_data' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'tags' => [
'<string>'
],
'folder_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id}"
payload := strings.NewReader("{\n \"file_name\": \"<string>\",\n \"title\": \"<string>\",\n \"alternate_text\": \"<string>\",\n \"description\": \"<string>\",\n \"meta_data\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"folder_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"file_name\": \"<string>\",\n \"title\": \"<string>\",\n \"alternate_text\": \"<string>\",\n \"description\": \"<string>\",\n \"meta_data\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"folder_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/media/files/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"file_name\": \"<string>\",\n \"title\": \"<string>\",\n \"alternate_text\": \"<string>\",\n \"description\": \"<string>\",\n \"meta_data\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"folder_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"file": {
"id": "<string>",
"file_name": "<string>",
"file_extension": "<string>",
"file_size": 123,
"file_type": "image",
"mime_type": "<string>",
"title": "<string>",
"alternate_text": "<string>",
"description": "<string>",
"meta_data": [
{
"key": "<string>",
"value": "<string>"
}
],
"tags": [
"<string>"
],
"folder_id": "<string>",
"upload_source": "local-storage",
"status": "ready",
"usage": [
{
"used_in": "product",
"used_in_reference_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"external_url": "<string>",
"url": {
"image_original": "<string>",
"image_standard": "<string>",
"image_thumbnail": "<string>",
"image_blur": "<string>"
}
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
file id
Body
application/json
Was this page helpful?
⌘I