Update an Extension

PUT

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

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

/partner_apps/:extension_id

Path parameters

• :extension_id required number

  Numeric id of an extension

Request body properties

• app The Extension Object

  The extension object

  Show The Extension Object child properties

  • 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

Examples

cURL

curl "https://mapi.storyblok.com/v1/org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72" \
  -X PUT \
  -H "Authorization: YOUR_PERSONAL_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"app\":{\"enable_space_settings\":true}}"

JS

// storyblok-js-client@>=7, node@>=18
import Storyblok from "storyblok-js-client";

const storyblok = new Storyblok({
  oauthToken: "YOUR_PERSONAL_ACCESS_TOKEN",
});

try {
  const response = await storyblok.put('org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72', {
    "app": {
      "enable_space_settings": true
    }
  })
  console.log({ response })
} catch (error) {
  console.log(error)
}

PHP

$client = new \Storyblok\ManagementClient('YOUR_PERSONAL_ACCESS_TOKEN');

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

$client->put('org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72', $payload)->getBody();

Java

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_PERSONAL_ACCESS_TOKEN")
  .body({"app":{"enable_space_settings":true}})
  .asString();

C#

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_PERSONAL_ACCESS_TOKEN");
request.AddParameter("application/json", "{\"app\":{\"enable_space_settings\":true}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

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_PERSONAL_ACCESS_TOKEN"
}

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

print(response.text)

Ruby

require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_PERSONAL_ACCESS_TOKEN')

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

client.put('org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72', payload)

Swift

let storyblok = URLSession(storyblok: .mapi(accessToken: .personal("YOUR_PERSONAL_ACCESS_TOKEN")))
var request = URLRequest(storyblok: storyblok, path: "org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72")
request.httpMethod = "PUT"
request.httpBody = try JSONSerialization.data(withJSONObject: [
    "app": [
        "enable_space_settings": true,
    ],
])
let (data, _) = try await storyblok.data(for: request)
print(try JSONSerialization.jsonObject(with: data))

Kotlin

val client = HttpClient {
    install(Storyblok(MAPI)) {
        accessToken = Personal("YOUR_PERSONAL_ACCESS_TOKEN")
    }
}

val response = client.put("org_apps/a8d372f8-5659-4f77-b549-0a82ff9c6e72") {
    setBody(buildJsonObject {
        putJsonObject("app") {
            put("enable_space_settings", true)
        }
    })
}

println(response.body<JsonElement>())