REST API: PUT collection field

Warning: You are viewing the documentation for the old REST API. We recommend using our latest version of the REST API.

Method to edit a certain field in a collection. To use this method you can make an HTTP PUT request to the following URL:


The first $id should be the collection you want to edit the field of and the second $id should be replaced by the ID of the field you want to edit. Any other information should be added to the message body of the HTTP request.

Available data

The following data must be put into the body of the request:

  • name: Name of the field
  • type Type of the field
  • value: Value of the field
  • displayed: Boolean value to indicate whether or not the field should be placed in grids and lists in the user interface
  • ordered: Boolean value to indicate whether or not profiles in the collection should be ordered by this field
  • length: Maximum length for text fields
  • textlines: Amount of text lines for text fields
  • hidden: Boolean value to indicate whether or not to always hide a field from a user
  • index: Boolean value to indicate whether or not to create an index on the field

PHP example

The following PHP script demonstrates how to use the method.

// dependencies

// change this into your access token
$api = new CopernicaRestApi("your-access-token");

// declare the id of the collection and field that you want to edit
$collection = 1;
$field = 1;

// data to be sent to the api
$data = array(
   'name'      => 'new_name'

// do the call
$api->put("collection/{$collection}/field/{$field}", $data);

The example above requires the CopernicaRestApi class.

More information