Create a Field Plugin

This endpoint allows you to create a field type plugin.

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

org_field_types/

partner_field_types/

Request Body Properties

field_type
The Field Plugins Object

The field plugin object
- 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
- id
  number
  
  Numeric ID of your field plugin
- name
  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.
- space_ids
  number[]
  
  Array of space ids where the field plugin is assigned to.
- options
  object[]
  
  Options added to the plugin
  - name
    string
    
    Name of the option
  - value
    string
    
    Default value of the option
- last_versions
  object[]
  
  Array of last versions of the plugin
  - id
    number
    
    ID of the version
  - event
    string
    
    Event
  - created_at
    string
    
    Date at which the version was created
  - author_id
    number
    
    ID of the author
  - author
    string
    
    Name of the author
  - item_id
    number
    
    Plugin ID
  - is_draft
    boolean
    
    If in draft
- belongs_to_partner
  boolean
  
  If the plugin belongs to a partner portal
- belongs_to_org
  boolean
  
  If the plugin belongs to an organization
- user
  object
  
  The user object

Select a Language

Request

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

Request

// 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)
  })

Request

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

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

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

Request

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

payload = {
  "field_type" =>  {
    "name" =>  "my-geo-selector"
  }
}

client.post('/field_types/', payload)

Request

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();

Request

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);

Request

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()

Request

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)

Prev Retrieve Multiple Field Plugins

Next Update a Field Plugin