Update a Field Plugin

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 client

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.put('field_types/123123', {
  "field_type": {
    "body": "const Fieldtype = {}",
    "compiled_body": ""
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => {
    console.log(error)
  })

PHP client

$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

import Foundation

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

let postData = NSData(data: {"field_type":{"body":"const Fieldtype = {}","compiled_body":""}}.data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/field_types/123123")! 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()