Skip to content
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
Cannot retrieve contributors at this time

REST API: PUT document (Publisher)

A method to update a document. This is an HTTP PUT method, accessible at the following address:$id?access_token=xxxx

Replace the $id by the identifier of the template you want to edit.

Available data

The following variables can be used in the body of the HTTP PUT request:

  • name: name of the document
  • description: description of the document
  • from_address: array with a 'name' and 'email' for the from address
  • subject: subject of the document

PHP example

The following example demonstrates how to use the API method:

// dependencies

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

// data to be sent to the api
$data = array(
     'name'        =>  'New name of the document'

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

The example above requires the CopernicaRestApi class.

More information