⚠️Draft Content
Storyblok
Search Storyblok's Documentation
  1. Update an Extension

Management API

Update an Extension

This endpoint allows you to update an extension, specifically the app object using the numeric ID.

https://mapi.storyblok.com/v1/org_apps/:extension_id
/partner_apps/:extension_id

Path Parameters

  • :extension_id

    required number

    Numeric id of an extension

Request Body Properties

  • app

    The Extension Object
    • name

      string

      Name of the Extension

    • slug

      string

      The slug specific to this Extension

    • icon

      string

      Icon image path of the Extension from the Extension Details

    • preview_video

      string

      Define the video URL in the extension configured on the Extension Details in the settings

    • description

      string

      A description of your extension

    • intro

      string

      A short description of your extension

    • screenshot

      string

      A screenshot image path of your extension

    • website

      string

      Website URL of your extension

    • author

      string

      Author of the extension

    • field_type_ids

      number[]

      An array of field type ids

    • embedded_app_url

      string

      An embedded Space app or Tool Plugin URL

    • dev_embedded_app_url

      string

      A developer mode of embedded Space Plugin or Tool Plugin URL

    • dev_oauth_redirect_uri

      string

      A developer mode of OAuth Space Plugin or Tool Plugin URI

    • in_sidebar

      boolean

      A status in the sidebar if your plugin is a space app

    • in_toolbar

      boolean

      A status in the toolbar if your plugin is tool plugin

    • sidebar_icon

      string

      Your space app sidebar icon image path

    • oauth_redirect_uri

      string

      OAuth Space Plugin or Tool Plugin URI

    • enable_space_settings

      boolean

      A status to show whether your extension is enabled for space level settings or not

Request
curl "https://mapi.storyblok.com/v1/org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72" \ 
  -X PUT \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"app\": {\"enable_space_settings\": true}}"
Request
// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.put('/org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72', {
  "app": {
    "enable_space_settings": true
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })
Request
$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');

$payload = [
  "app" =>  [
    "enable_space_settings" =>  true
  ]
];

$client->put('/org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72', $payload)->getBody();
Request
require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

payload = {
  "app" =>  {
    "enable_space_settings" =>  true
  }
}

client.put('/org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72', payload)
Request
HttpResponse<String> response = Unirest.put("https://mapi.storyblok.com/v1/org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body("{\"app\": {\"enable_space_settings\": true}}")
  .asString();
Request
var client = new RestClient("https://mapi.storyblok.com/v1/org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72");
var request = new RestRequest(Method.PUT);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"app\": {\"enable_space_settings\": true}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Request
import Foundation

let headers = [
  "Content-Type": "application/json",
  "Authorization": "YOUR_OAUTH_TOKEN"
]

let postData = NSData(data: "{\"app\": {\"enable_space_settings\": true}}".data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72")! 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()
Request
import requests

url = "https://mapi.storyblok.com/v1/org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72"

querystring = {}

payload = "{\"app\": {\"enable_space_settings\": true}}"
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

response = requests.request("PUT", url, data=payload, headers=headers, params=querystring)

print(response.text)