Create a Field Plugin

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

This endpoint allows you to create a field type plugin.

org_field_types/

partner_field_types/

Request body properties

• field_type The Field Plugins Object

  The field plugin object

  Show The Field Plugins Object child properties

  • name required string

    Given name of your field plugin. Needs to be unique. A personal prefix is recommended (Example: my-geo-selector).

  • 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.

Response properties

• field_type The Field Plugins Object

  Array of field plugin object

Examples

cURL

curl "https://mapi.storyblok.com/v1/field_types/" \
  -X POST \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"field_type\":{\"name\":\"my-geo-selector\"}}"

JS client

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('field_types/', {
  "field_type": {
    "name": "my-geo-selector"
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => {
    console.log(error)
  })

PHP client

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

$payload = ["field_type" => ["name" => "my-geo-selector"]];

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

Java

HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/field_types/")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body({"field_type":{"name":"my-geo-selector"}})
  .asString();

C#

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

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"field_type\":{\"name\":\"my-geo-selector\"}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

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

querystring = {}

payload = {"field_type":{"name":"my-geo-selector"}}
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

response = requests.request("POST", 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" => {"name" => "my-geo-selector"}}

client.post('field_types/', payload)

Swift

import Foundation

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

let postData = NSData(data: {"field_type":{"name":"my-geo-selector"}}.data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/field_types/")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)
request.method = "POST"
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()