Update a Preset
This endpoint can be used to update presets using the numeric ID.
https://mapi.storyblok.com/v1/spaces/:space_id/presets/:preset_id
Path Parameters
-
:space_id
required numberNumeric ID of a space
-
:preset_id
required numberNumeric ID of your preset
Request Body Properties
-
preset
The Preset ObjectA single preset object
-
name
stringGiven name of your preset
-
preset
objectFields of the component filled with content
-
component_id
numberThe ID of the component the preset is for
-
image
string or nullScreenshot or other preview image for your editor; Default: null
-
color
stringColor of the preset icon
-
icon
stringIcon of the preset
-
description
stringA description of the preset for the editors
-
Response Properties
-
preset
The Preset ObjectA single preset object
-
id
numberNumeric ID of your preset
-
name
stringGiven name of your preset
-
preset
objectFields of the component filled with content
-
component_id
numberThe ID of the component the preset is for
-
space_id
numberNumeric ID of a space
-
created_at
stringCreation date (Format:
yyyy-MM-dd'T'HH:mm:ssZ
) -
updated_at
stringLatest update date (Format:
yyyy-MM-dd'T'HH:mm:ssZ
) -
image
string or nullScreenshot or other preview image for your editor; Default: null
-
color
stringColor of the preset icon
-
icon
stringIcon of the preset
-
description
stringA description of the preset for the editors
-
Example Request
curl "https://mapi.storyblok.com/v1/spaces/606/presets/1814" \
-X PUT \
-H "Authorization: YOUR_OAUTH_TOKEN" \
-H "Content-Type: application/json" \
-d "{\"preset\": {\"name\": \"Teaser with headline and image\",\"preset\": {\"headline\": \"This is a default value for the preset!\",\"image\": \"//a.storyblok.com/f/606/...\"},\"component_id\": 62,}}"
// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.put('/spaces/606/presets/1814', {
"preset": {
"name": "Teaser with headline and image",
"preset": {
"headline": "This is a default value for the preset!",
"image": "//a.storyblok.com/f/606/..."
},
"component_id": 62,
}
})
.then(response => {
console.log(response)
}).catch(error => {
console.log(error)
})
$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');
$payload = [
"preset" => [
"name" => "Teaser with headline and image",
"preset" => [
"headline" => "This is a default value for the preset!",
"image" => "//a.storyblok.com/f/606/..."
],
"component_id" => 62,
]
];
$client->put('/spaces/606/presets/1814', $payload)->getBody();
require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')
payload = {
"preset" => {
"name" => "Teaser with headline and image",
"preset" => {
"headline" => "This is a default value for the preset!",
"image" => "//a.storyblok.com/f/606/..."
},
"component_id" => 62,
}
}
client.put('/spaces/606/presets/1814', payload)
HttpResponse<String> response = Unirest.put("https://mapi.storyblok.com/v1/spaces/606/presets/1814")
.header("Content-Type", "application/json")
.header("Authorization", "YOUR_OAUTH_TOKEN")
.body("{\"preset\": {\"name\": \"Teaser with headline and image\",\"preset\": {\"headline\": \"This is a default value for the preset!\",\"image\": \"//a.storyblok.com/f/606/...\"},\"component_id\": 62,}}")
.asString();
var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/presets/1814");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"preset\": {\"name\": \"Teaser with headline and image\",\"preset\": {\"headline\": \"This is a default value for the preset!\",\"image\": \"//a.storyblok.com/f/606/...\"},\"component_id\": 62,}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
import Foundation
let headers = [
"Content-Type": "application/json",
"Authorization": "YOUR_OAUTH_TOKEN"
]
let postData = NSData(data: "{\"preset\": {\"name\": \"Teaser with headline and image\",\"preset\": {\"headline\": \"This is a default value for the preset!\",\"image\": \"//a.storyblok.com/f/606/...\"},\"component_id\": 62,}}".data(using: String.Encoding.utf8)!)
let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/606/presets/1814")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)
request.method = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
import requests
url = "https://mapi.storyblok.com/v1/spaces/606/presets/1814"
querystring = {}
payload = "{\"preset\": {\"name\": \"Teaser with headline and image\",\"preset\": {\"headline\": \"This is a default value for the preset!\",\"image\": \"//a.storyblok.com/f/606/...\"},\"component_id\": 62,}}"
headers = {
'Content-Type': "application/json",
'Authorization': "YOUR_OAUTH_TOKEN"
}
response = requests.request("PUT", url, data=payload, headers=headers, params=querystring)
print(response.text)
You will receive a fully loaded preset object as response.