API
  • Yumpu documentations
  • JS
    • Introduction
    • Quick setup
    • Magazine example's
    • Bookshelf example's
    • FAQs
  • API
    • Introduction
    • Getting started
      • API token
      • Document API
      • User API
      • Search API
      • Install SDK's
    • Limits
    • Flowchart of basic processes
    • Documents
      • Get
    • Document
      • Get
      • Post file
      • Post url
      • Put
      • Delete
    • Document hotspots
      • Get
    • Document hotspot
      • Get
      • Post
      • Put
      • Delete
    • Document progress
      • Get
    • Document categories
      • Get
    • Document languages
      • Get
    • Countries
      • Get
    • Collections
      • Get
    • Collection
      • Get
      • Post
      • Put
      • Delete
    • Section
      • Get
      • Post
      • Put
      • Delete
    • Section document
      • Post
      • Delete
    • Search
      • Get
    • User
      • Get
      • Post
      • Put
    • Embeds
      • Get
    • Embed
      • Get
      • Post
      • Put
      • Delete
    • Members
      • Get
    • Member
      • Get
      • Post
      • Put
      • Delete
    • Access tags
      • Get
    • Access tag
      • Get
      • Post
      • Put
      • Delete
    • Subscriptions
      • Get
    • Subscription
      • Get
      • Post
      • Put
      • Delete
Powered by GitBook
On this page
  • Delete one document hotspot
  • Parameters:

Was this helpful?

  1. API
  2. Document hotspot

Delete

Delete one document hotspot

Parameters:

Name

Optional / Required

Data type

Description

Default

id

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"
}
PreviousPutNextDocument progress

Last updated 3 years ago

Was this helpful?