Delete

Delete one document hotspot

Parameters:

Name

Optional / Required

Data type

Description

Default

required

String

One of your document hotspot ids

Example:

curl -X DELETE -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" -d "id=2d914999Iikh4a3I" "https://api.yumpu.com/2.0/document/hotspot.json"

Example:

require_once('../yumpu.php');
$yumpu = new Yumpu();
$id = '02784dc6chuNtFd2';
$response = $yumpu->deleteDocumentHotspot($id);
print_r($response);

Example:

var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
  id: '2d914999Iikh4a3I'
};
yumpu.deleteDocumentHotspot(parameters, function(statusCode, document){
   console.log('Status: ' + statusCode);
   console.log(document);
});

Example:

Yumpu y = new Yumpu("your access token");
String id = "b762266fEuN7Bb5L";
System.out.println(y.deleteDocumentHotspot(id));

Whatever language you are using, the result will be the same.

{
  "state": "success",
  "completed_in": "0.0871"
}

PreviousPut NextDocument progress

Last updated 2 years ago