Update a Field Plugin

PUT

https://mapi.storyblok.com/v1/field_types/:field_type_id

This endpoint can be used to perform updates to a field type plugin.

org_field_types/:field_type_id

partner_field_types/:field_type_id

Path parameters

• :field_type_id required number

  Numeric id of the field plugin

Request body properties

• field_type The Field Plugins Object

  The field plugin object

  Show The Field Plugins Object child properties

  • body string

    The uncompiled JavaScript code of the field plugin.

  • compiled_body string

    Used by the online code editor. Needs to be an empty string if using local plugin development.

  • space_ids number[]

    Array of space ids where the field plugin is assigned to.

  • options object[]

    Options added to the plugin

    Show child properties

    • name string

      Name of the option

    • value string

      Default value of the option

• publish number

  If this parameter is not empty the field plugin will be published.

Examples

cURL

curl "https://mapi.storyblok.com/v1/field_types/123123" \
  -X PUT \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"field_type\":{\"body\":\"const Fieldtype = {}\",\"compiled_body\":\"\"}}"

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('field_types/123123', {
  "field_type": {
    "body": "const Fieldtype = {}",
    "compiled_body": ""
  }
})
  console.log({ response })
} catch (error) {
  console.log(error)
}

PHP

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

$payload = ["field_type" => ["body" => "const Fieldtype = []","compiled_body" => ""]];

$client->put('field_types/123123', $payload)->getBody();

Java

HttpResponse<String> response = Unirest.put("https://mapi.storyblok.com/v1/field_types/123123")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body({"field_type":{"body":"const Fieldtype = {}","compiled_body":""}})
  .asString();

C#

var client = new RestClient("https://mapi.storyblok.com/v1/field_types/123123");
var request = new RestRequest(Method.PUT);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"field_type\":{\"body\":\"const Fieldtype = {}\",\"compiled_body\":\"\"}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/field_types/123123"

querystring = {}

payload = {"field_type":{"body":"const Fieldtype = {}","compiled_body":""}}
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_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_OAUTH_TOKEN')

payload = {"field_type" => {"body" => "const Fieldtype = {}","compiled_body" => ""}}

client.put('field_types/123123', payload)

Swift

let storyblok = URLSession(storyblok: .mapi(accessToken: .oauth("YOUR_OAUTH_TOKEN")))
var request = URLRequest(storyblok: storyblok, path: "field_types/123123")
request.httpMethod = "PUT"
request.httpBody = try JSONSerialization.data(withJSONObject: [
    "field_type": [
        "body": "const Fieldtype = {}",
        "compiled_body": "",
    ],
])
let (data, _) = try await storyblok.data(for: request)
print(try JSONSerialization.jsonObject(with: data))

Kotlin

val client = HttpClient {
    install(Storyblok(MAPI)) {
        accessToken = OAuth("YOUR_OAUTH_TOKEN")
    }
}

val response = client.put("field_types/123123") {
    setBody(buildJsonObject {
        putJsonObject("field_type") {
            put("body", "const Fieldtype = {}")
            put("compiled_body", "")
        }
    })
}

println(response.body<JsonElement>())