Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 1.15 KB

rest-put-collection.md

File metadata and controls

53 lines (35 loc) · 1.15 KB

REST API: PUT collection

Method to change the properties of a collection. This method can be used by sending an HTTP PUT request to the following URL:

https://api.copernica.com/v4/collection/$id

The $id should be replaced with the ID of the collection that you want to edit.

Available data

The following properties can be adjusted by placing their new values in the message body of the HTTP PUT command:

  • name: the new name of the collection

JSON example

The following JSON demonstrates how to use the API method:

{
  "name": "my_collection",
}

PHP example

The following PHP script demonstrates how to call the API method:

// dependencies
require_once('copernica-rest-api.php');

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

// data to be sent to the api
$data = array(
    'name'  =>  'new-collection-name'
);
    
// do the call
$api->put("collection/{$collectionID}", $data);

The example above requires the CopernicaRestApi class.

More information