# Post

## Create a new document hotspot

### Parameters:

<table data-header-hidden><thead><tr><th width="160">Name</th><th>Optional / Required</th><th width="109">Data type</th><th width="258">Description</th><th>Default</th></tr></thead><tbody><tr><td>Name</td><td>Optional / Required</td><td>Data type</td><td>Description</td><td>Default</td></tr><tr><td>document_id</td><td>required</td><td>Integer</td><td>One of your document ids</td><td></td></tr><tr><td>page</td><td>required</td><td>String</td><td>Page number (1-X)</td><td></td></tr><tr><td>type</td><td>required</td><td>String</td><td>Type can be link, video, audio or slideshow</td><td></td></tr><tr><td>settings[x]</td><td>required</td><td>Integer</td><td>x position of the document hotspot</td><td></td></tr><tr><td>settings[y]</td><td>required</td><td>Integer</td><td>y position of the document hotspot</td><td></td></tr><tr><td>settings[w]</td><td>required</td><td>Integer</td><td>width of the document hotspot</td><td></td></tr><tr><td>settings[h]</td><td>required</td><td>Integer</td><td>height of the document hotspot</td><td></td></tr><tr><td>settings[name]</td><td>required</td><td>String</td><td>a name for the document hotspot (min. length 5, max. length 50)</td><td></td></tr><tr><td>settings[tooltip]</td><td>required</td><td>String</td><td>a tooltip for the document hotspot (min. length 5, max. length 50)</td><td></td></tr><tr><td>settings[link]</td><td>optional</td><td>String</td><td>a url (valid URL)</td><td></td></tr><tr><td>settings[source]</td><td>optional</td><td>String</td><td>youtube, vimeo, flickr, soundcloud, yumpu</td><td></td></tr><tr><td>settings[source_id]</td><td>optional</td><td>String</td><td>youtube: a valid youtube video id vimeo: a valid vimeo video id flickr: a valid flickr id</td><td></td></tr><tr><td>settings[source_ids]</td><td>optional</td><td>String</td><td>One or multiple media ids separated by a comma (example: GlKIWjJyWtg2XFKi,tFtOzlqZyqeaNkfw)</td><td></td></tr><tr><td>settings[source_url]</td><td>optional</td><td>String</td><td>soundcloud: a valid soundcloud url</td><td></td></tr><tr><td>settings[autoplay]</td><td>optional</td><td>String</td><td>y or n</td><td></td></tr><tr><td>settings[show_arrows]</td><td>optional</td><td>String</td><td>y or n</td><td></td></tr><tr><td>settings[show_headline]</td><td>optional</td><td>String</td><td>y or n</td><td></td></tr><tr><td>settings[object_fit]</td><td>optional</td><td>String</td><td>"cover" or "contain"</td><td></td></tr><tr><td>settings[background_opacity]</td><td>optional</td><td>Float</td><td>0.0 to 1</td><td></td></tr><tr><td>settings[background_color]</td><td>optional</td><td>String</td><td>Hexadecimal value, 6 characters.<br>#000000 - #FFFFFF</td><td></td></tr><tr><td>settings[background_color_hover]</td><td>optional</td><td>String</td><td>Hexadecimal value, 6 characters.<br>#000000 - #FFFFFF</td><td></td></tr><tr><td>settings[background_color_hover_opacity]</td><td>optional</td><td>Float</td><td>0.0 to 1</td><td></td></tr><tr><td>settings[hideborder]</td><td>optional</td><td>String</td><td>y or n</td><td></td></tr><tr><td>settings[asarea]</td><td>optional</td><td>String</td><td>y or n</td><td></td></tr><tr><td>settings[icon_color]</td><td>optional</td><td>String</td><td>Hexadecimal value, 6 characters.<br>#000000 - #FFFFFF</td><td></td></tr><tr><td>settings[icon_opacity]</td><td>optional</td><td>Float</td><td>0.0 to 1</td><td></td></tr><tr><td>settings[icon_color_hover]</td><td>optional</td><td>String</td><td>Hexadecimal value, 6 characters.<br>#000000 - #FFFFFF</td><td></td></tr><tr><td>settings[icon_color_hover_opacity]</td><td>optional</td><td>Float</td><td>0.0 to 1</td><td></td></tr><tr><td>settings[icon_size]</td><td>optional</td><td>Integer</td><td>(min 14) - (max 64)</td><td></td></tr><tr><td>settings[icon_url]</td><td>optional</td><td>String</td><td>See below for available icons</td><td></td></tr></tbody></table>

<details>

<summary>Icons (currently only available for the Link and Audio elements)</summary>

* `fa-link`
* `fa-link-simple`
* `fa-link-horizontal`
* `fa-arrow-up-right-from-square`
* `fa-square-arrow-up-right`
* `fa-dollar-sign`
* `fa-euro-sign`
* `fa-sterling-sign`
* `fa-money-bill-wave`
* `fa-credit-card`
* `fa-cart-shopping`
* `fa-bag-shopping`
* `fa-basket-shopping`
* `fa-cart-plus`
* `fa-shop`
* `fa-store`
* `fa-globe`
* `fa-envelope`
* `fa-comments`
* `fa-info`
* `fa-user`
* `fa-book`
* `fa-map-location-dot`
* `fa-play`
* `fa-music`
* `fa-volume`
* `fa-volume-low`
* `fa-volume-high`
* `fa-headphones`
* `fa-play-pause`
* `fa-podcast`
* `fa-repeat`
* `fa-microphone`
* `fa-microphone-lines`
* `fa-speaker`

</details>

### Demo

&#x20;URL Find your token on - [yumpu.com](https://www.yumpu.com/en/account/profile/api) Token&#x20;

&#x20;document\_id  page  type  settings\[x]  settings\[y]  settings\[w]  settings\[h]  settings\[name]  settings\[tooltip]&#x20;

#### Optional parameters:

&#x20;settings\[link]  settings\[source]  settings\[source\_id]  settings\[source\_ids]  settings\[source\_url]  settings\[autoplay]&#x20;

Add optional parametersRun request

```
```

{% tabs %}
{% tab title="curl" %}
Example:

```
curl -X POST -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" -d "document_id=27109085" -d "page=4" -d "type=link" -d "settings[x]=100" -d "settings[y]=100" -d "settings[w]=50" -d "settings[h]=50" -d "settings[name]=google.com" -d "settings[tooltip]=google.com" -d "settings[link]=https://www.google.com" "https://api.yumpu.com/2.0/document/hotspot.json"
```

{% endtab %}

{% tab title="PHP" %}
Example:

```php
require_once('../yumpu.php');
$yumpu = new Yumpu();
$data = array(
    'document_id' => '55919352',
    'page' => '1',
    'type' => 'link',
    'settings' => array(
        'x' => 100,
        'y' => 100,
        'w' => 20,
        'h' => 20,
        'name' => 'google.com',
        'tooltip' => 'google.com',
        'link' => 'https://www.yumpu.com'
    )
);
$hotspot = $yumpu->postDocumentHotspot($data);
print_r($hotspot);
```

{% endtab %}

{% tab title="JavaScript" %}
Example:

```javascript
var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
   document_id: 27109085,
   page: 4,
   type: 'link',
   settings: {
       x: 100,
       y: 100,
       w: 50,
       h: 50,
       name: 'google.com',
       tooltip: 'google.com',
       link: 'https://www.yumpu.com'
   }
};
yumpu.postDocumentHotspot(parameters, function(statusCode, document){
   console.log('Status: ' + statusCode);
   console.log(document);
});
```

{% endtab %}

{% tab title="Java" %}
Example:

```java
Yumpu y = new Yumpu("your access token");
String[] params = {"document_id=27109085", "type=link", "page=4"};
String[] settings = {"x=100", "y=100", "w=50", "h=50", "name=google.com", "tooltip=google.com", "link=https://www.yumpu.com"};
System.out.println(y.postDocumentHotspot(params, settings));
```

{% endtab %}
{% endtabs %}

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

```bash
{
  "hotspot": [
    {
      "id": "5c905d027BHYFhLg",
      "document_id": "27109085",
      "page": "4",
      "type": "link",
      "settings": {
        "x": "100",
        "y": "100",
        "w": "50",
        "h": "50",
        "name": "google.com",
        "tooltip": "google.com",
        "link": "https://www.yumpu.com"
      },
      "create_date": "2014-09-23 08:18:53",
      "update_date": "0000-00-00 00:00:00"
    }
  ],
  "state": "success",
  "completed_in": "0.1644"
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.yumpu.com/api/document-hotspot/documenthotspotpost.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.