> For the complete documentation index, see [llms.txt](https://developers.yumpu.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.yumpu.com/api/embed/embedput.md). # Put ## Update an existing embed ### Parameters: | Name | Optional / Required | Data type | Description | Default | | ---- | ------------------- | --------- | ----------- | ------- | | id | required | String | One of your embed ids | | | -- | -------- | ------ | --------------------- | - | | document\_id | required | Integer | One of your document ids or a public document id from the Yumpu Users | | | ------------ | -------- | ------- | --------------------------------------------------------------------- | - | | type | required | Integer | 1 (player), 2 (logo), 3 (link), 4 (button), 5 (cover), 6 (bookshelf) or 7 (player\_preset) | | | ---- | -------- | ------- | ------------------------------------------------------------------------------------------ | - | **Request parameters by type (1 = player)** | Name | Optional / Required | Data type | Description | Default | | ---- | ------------------- | --------- | ----------- | ------- | | start\_page | optional | Integer | Start magazine from page x | 1 | | ----------- | -------- | ------- | -------------------------- | - | | width | optional | Integer | Width of the embed | 620 | | ----- | -------- | ------- | ------------------ | --- | | height | optional | Integer | Height of the embed | 580 | | ------ | -------- | ------- | ------------------- | --- | | page\_view | optional | String | single\_page or double\_page | double\_page | | ---------- | -------- | ------ | ---------------------------- | ------------ | | title | optional | String | Max. characters 255 | Magazine title | | ----- | -------- | ------ | ------------------- | -------------- | | title\_font\_family | optional | String | A font family from the Google Fonts API | ABeeZee:regular:latin | | ------------------- | -------- | ------ | --------------------------------------- | --------------------- | | title\_font\_weight | optional | String | Bold (y) or normal (n) font weight | n | | ------------------- | -------- | ------ | ---------------------------------- | - | | title\_font\_style | optional | String | Italic font (y or n) | n | | ------------------ | -------- | ------ | -------------------- | - | | title\_font\_size | optional | Integer | Font size in px (8 - 76) | 14 | | ----------------- | -------- | ------- | ------------------------ | -- | | title\_font\_color | optional | String | Hexadecimal value, 6 characters | FFFFFF | | ------------------ | -------- | ------ | ------------------------------- | ------ | | headline\_enabled | optional | String | Display headline (title must also be set) - y or n | y | | ----------------- | -------- | ------ | -------------------------------------------------- | - | | username\_enabled | optional | String | Display username (title must also be set) - y or n | y | | ----------------- | -------- | ------ | -------------------------------------------------- | - | | background\_color | optional | String | Hexadecimal value, 6 characters | 253139 | | ----------------- | -------- | ------ | ------------------------------- | ------ | | fullscreen\_background\_color | optional | String | Hexadecimal value, 6 characters | 253139 | | ----------------------------- | -------- | ------ | ------------------------------- | ------ | | outline\_enabled | optional | String | Display a border of the embed (y or n) | n | | ---------------- | -------- | ------ | -------------------------------------- | - | | outline\_size | optional | Integer | Border width (1 - 5) | 1 | | ------------- | -------- | ------- | -------------------- | - | | icons\_color | optional | String | Hexadecimal value, 6 characters | ffffff | | ------------- | -------- | ------ | ------------------------------- | ------ | | arrows\_color | optional | String | Hexadecimal value, 6 characters | ffffff | | text\_font\_weight | optional | String | Bold (y) or normal (n) font weight | n | | ------------------ | -------- | ------ | ---------------------------------- | - | | text\_font\_style | optional | String | Italic font (y or n) | n | | ----------------- | -------- | ------ | -------------------- | - | | player\_autoflip\_enabled | optional | String | Autoflip pages (y or n) | n | | ------------------------- | -------- | ------ | ----------------------- | - | | player\_c2r\_enabled | optional | String | Display click to read button (y or n) | y | | -------------------- | -------- | ------ | ------------------------------------- | - | | player\_c2r\_text | optional | String | Click to read text | Click to read | | ----------------- | -------- | ------ | ------------------ | ------------- | | player\_c2r\_destination | optional | String | Onclick link of click to read button (fullscreen or onyumpu) | fullscreen | | ------------------------ | -------- | ------ | ------------------------------------------------------------ | ---------- | | player\_c2r\_type | optional | String | Template style of click to read button (buttonClassic, buttonRounded, iconEye, iconPlay) | buttonClassic | | ----------------- | -------- | ------ | ---------------------------------------------------------------------------------------- | ------------- | | player\_c2r\_mobile | optional | String | Template style of click to read button in mobile (buttonClassic, buttonRounded, iconEye, iconPlay) | buttonClassic | | ------------------- | -------- | ------ | -------------------------------------------------------------------------------------------------- | ------------- | | player\_elements\_page\_numbers | optional | String | Display page numbers (y or n) | y | | ------------------------------- | -------- | ------ | ----------------------------- | - | | player\_elements\_logo | optional | String | Display logo (y or n) | y | | ---------------------- | -------- | ------ | --------------------- | - | | player\_elements\_overview | optional | String | Display overview (y or n) | y | | -------------------------- | -------- | ------ | ------------------------- | - | | player\_elements\_search\_embed | optional | String | Display search button in GUI when embedded == true (y or n) | n | | ------------------------------- | -------- | ------ | ----------------------------------------------------------- | - | | player\_elements\_fs\_share | optional | String | Display facebook link (y or n) | y | | --------------------------- | -------- | ------ | ------------------------------ | - | | player\_elements\_fs\_download | optional | String | Display dowload link (y or n) | y | | ------------------------------ | -------- | ------ | ----------------------------- | - | | player\_elements\_fs\_print | optional | String | Display link to print the magazine (y or n) | y | | --------------------------- | -------- | ------ | ------------------------------------------- | - | | player\_elements\_fs\_recom | optional | String | Display recommended (y or n) | y | | --------------------------- | -------- | ------ | ---------------------------- | - | **Request parameters by type (2 = logo)** | Name | Optional / Required | Data type | Description | Default | | ---- | ------------------- | --------- | ----------- | ------- | | width | optional | Integer | Width of the embed | 64 | | ----- | -------- | ------- | ------------------ | -- | | background\_shape | optional | String | Template of the embed (circle, rounded, square, y) | circle | | ----------------- | -------- | ------ | -------------------------------------------------- | ------ | | color | optional | String | Color (orange, white, black, grey) | orange | | ----- | -------- | ------ | ---------------------------------- | ------ | | destination | optional | String | Onclick link (magazinePage or magazine) | magazine | | ----------- | -------- | ------ | --------------------------------------- | -------- | | destination\_fullscreen | optional | String | Onclick link fullscreen (y or n) | n | | ----------------------- | -------- | ------ | -------------------------------- | - | **Request parameters by type (3 = link)** | Name | Optional / Required | Data type | Description | Default | | ---- | ------------------- | --------- | ----------- | ------- | | width | optional | Integer | Width of the embed | 271 | | ----- | -------- | ------- | ------------------ | --- | | height | optional | Integer | Height of the embed | 43 | | ------ | -------- | ------- | ------------------- | -- | | title | optional | String | Max. characters 255 | Magazine title | | ----- | -------- | ------ | ------------------- | -------------- | | title\_font\_family | optional | String | A font family from the Google Fonts API | ABeeZee:regular:latin | | ------------------- | -------- | ------ | --------------------------------------- | --------------------- | | title\_font\_weight | optional | String | Bold (y) or normal (n) font weight | n | | ------------------- | -------- | ------ | ---------------------------------- | - | | title\_font\_style | optional | String | Italic font (y or n) | n | | ------------------ | -------- | ------ | -------------------- | - | | title\_font\_size | optional | Integer | Font size in px (8 - 76) | 14 | | ----------------- | -------- | ------- | ------------------------ | -- | | title\_font\_color | optional | String | Hexadecimal value, 6 characters | 0082b2 | | ------------------ | -------- | ------ | ------------------------------- | ------ | | background\_color | optional | String | Hexadecimal value, 6 characters or transparent | transparent | | ----------------- | -------- | ------ | ---------------------------------------------- | ----------- | | outline\_enabled | optional | String | Display a border of the embed (y or n) | n | | ---------------- | -------- | ------ | -------------------------------------- | - | | outline\_size | optional | Integer | Border width (1 - 5) | 1 | | ------------- | -------- | ------- | -------------------- | - | | outline\_color | optional | String | Border color (hexadecimal value, 6 characters) | 333333 | | -------------- | -------- | ------ | ---------------------------------------------- | ------ | | destination | optional | String | Onclick link (magazinePage or magazine) | magazine | | ----------- | -------- | ------ | --------------------------------------- | -------- | | destination\_fullscreen | optional | String | Onclick link fullscreen (y or n) | y | | ----------------------- | -------- | ------ | -------------------------------- | - | | download\_pdf\_enabled | optional | String | Show download pdf link (y or n) | n | | ---------------------- | -------- | ------ | ------------------------------- | - | | download\_pdf\_title | optional | String | Text of the download PDF link | download PDF | | -------------------- | -------- | ------ | ----------------------------- | ------------ | **Request parameters by type (4 = button)** | Name | Optional / Required | Data type | Description | Default | | ---- | ------------------- | --------- | ----------- | ------- | | start\_page | optional | Integer | Start magazine from page x | 1 | | ----------- | -------- | ------- | -------------------------- | - | | width | optional | Integer | Width of the embed | 118 | | ----- | -------- | ------- | ------------------ | --- | | height | optional | Integer | Height of the embed | 39 | | ------ | -------- | ------- | ------------------- | -- | | title | optional | String | Max. characters 255 | Magazine title | | ----- | -------- | ------ | ------------------- | -------------- | | text\_font\_family | optional | String | A font family from the Google Fonts API | ABeeZee:regular:latin | | ------------------ | -------- | ------ | --------------------------------------- | --------------------- | | text\_font\_weight | optional | String | Bold (y) or normal (n) font weight | n | | ------------------ | -------- | ------ | ---------------------------------- | - | | text\_font\_style | optional | String | Italic font (y or n) | n | | ----------------- | -------- | ------ | -------------------- | - | | text\_font\_size | optional | Integer | Font size in px (8 - 76) | 14 | | ---------------- | -------- | ------- | ------------------------ | -- | | text\_font\_color | optional | String | Hexadecimal value, 6 characters | FFFFFF | | ----------------- | -------- | ------ | ------------------------------- | ------ | | background\_color | optional | String | Hexadecimal value, 6 characters or transparent | 253139 | | ----------------- | -------- | ------ | ---------------------------------------------- | ------ | | destination | optional | String | Onclick link (magazinePage or magazine) | magazine | | ----------- | -------- | ------ | --------------------------------------- | -------- | | destination\_fullscreen | optional | String | Onclick link fullscreen (y or n) | y | | ----------------------- | -------- | ------ | -------------------------------- | - | | download\_pdf\_enabled | optional | String | Show download pdf link (y or n) | n | | ---------------------- | -------- | ------ | ------------------------------- | - | | download\_pdf\_title | optional | String | Text of the download PDF link | download PDF | | -------------------- | -------- | ------ | ----------------------------- | ------------ | **Request parameters by type (5 = cover)** | Name | Optional / Required | Data type | Description | Default | | ---- | ------------------- | --------- | ----------- | ------- | | start\_page | optional | Integer | Start magazine from page x | 1 | | ----------- | -------- | ------- | -------------------------- | - | | width | optional | Integer | Width of the embed | 280 | | ----- | -------- | ------- | ------------------ | --- | | height | optional | Integer | Height of the embed | 399 | | ------ | -------- | ------- | ------------------- | --- | | title | optional | String | Max. characters 255 | Magazine title | | ----- | -------- | ------ | ------------------- | -------------- | | title\_font\_family | optional | String | A font family from the Google Fonts API | ABeeZee:regular:latin | | ------------------- | -------- | ------ | --------------------------------------- | --------------------- | | title\_font\_weight | optional | String | Bold (y) or normal (n) font weight | n | | ------------------- | -------- | ------ | ---------------------------------- | - | | title\_font\_style | optional | String | Italic font (y or n) | n | | ------------------ | -------- | ------ | -------------------- | - | | title\_font\_size | optional | Integer | Font size in px (8 - 76) | 14 | | ----------------- | -------- | ------- | ------------------------ | -- | | title\_font\_color | optional | String | Hexadecimal value, 6 characters | FFFFFF | | ------------------ | -------- | ------ | ------------------------------- | ------ | | headline\_enabled | optional | String | Display headline (title must also be set) - y or n | y | | ----------------- | -------- | ------ | -------------------------------------------------- | - | | username\_enabled | optional | String | Display username (title must also be set) - y or n | y | | ----------------- | -------- | ------ | -------------------------------------------------- | - | | background\_color | optional | String | Hexadecimal value, 6 characters or transparent | 253139 | | ----------------- | -------- | ------ | ---------------------------------------------- | ------ | | destination | optional | String | Onclick link (magazinePage or magazine) | magazine | | ----------- | -------- | ------ | --------------------------------------- | -------- | | destination\_fullscreen | optional | String | Onclick link fullscreen (y or n) | y | | ----------------------- | -------- | ------ | -------------------------------- | - | | border\_disabled | optional | String | Show just cover, no border, no username, no title (y or n) | n | | ---------------- | -------- | ------ | ---------------------------------------------------------- | - | | download\_pdf\_enabled | optional | String | Show download pdf link (y or n) | n | | ---------------------- | -------- | ------ | ------------------------------- | - | | download\_pdf\_title | optional | String | Text of the download PDF link | download PDF | | -------------------- | -------- | ------ | ----------------------------- | ------------ | | cover\_c2r\_enabled | optional | String | Click to read (y or n) | n | | ------------------- | -------- | ------ | ---------------------- | - | **Request parameters by type (6 = bookshelf)** | Name | Optional / Required | Data type | Description | Default | | ---- | ------------------- | --------- | ----------- | ------- | | section\_title\_enabled | optional | String | Show section titles (y or n) | y | | ----------------------- | -------- | ------ | ---------------------------- | - | | headline\_enabled | optional | String | Display headline (title must also be set) - y or n | y | | ----------------- | -------- | ------ | -------------------------------------------------- | - | | background\_color | optional | String | Hexadecimal value, 6 characters | 253139 | | ----------------- | -------- | ------ | ------------------------------- | ------ | | destination\_fullscreen | optional | String | Onclick link fullscreen (y or n) | y | | ----------------------- | -------- | ------ | -------------------------------- | - | | force\_swf\_overlay | optional | String | Force SWF overlay (y or n) | n | | ------------------- | -------- | ------ | -------------------------- | - | | cpMagT | optional | String | Show centipede magazine titles (no, top or bottom) | no | | ------ | -------- | ------ | -------------------------------------------------- | -- | **Request parameters by type (7 = player\_preset)** | Name | Optional / Required | Data type | Description | Default | | ---- | ------------------- | --------- | ----------- | ------- | | start\_page | optional | Integer | Start magazine from page x | 1 | | ----------- | -------- | ------- | -------------------------- | - | | width | optional | Integer | Width of the embed | 620 | | ----- | -------- | ------- | ------------------ | --- | | height | optional | Integer | Height of the embed | 548 | | ------ | -------- | ------- | ------------------- | --- | | icons\_color | optional | String | Hexadecimal value, 6 characters | ffffff | | ------------- | -------- | ------ | ------------------------------- | ------ | | arrows\_color | optional | String | Hexadecimal value, 6 characters | ffffff | | player\_autoflip\_enabled | optional | String | Autoflip pages (y or n) | n | | ------------------------- | -------- | ------ | ----------------------- | - | | player\_c2r\_enabled | optional | String | Display click to read button (y or n) | y | | -------------------- | -------- | ------ | ------------------------------------- | - | | player\_c2r\_text | optional | String | Click to read text | Click to read | | ----------------- | -------- | ------ | ------------------ | ------------- | | player\_c2r\_destination | optional | String | Onclick link of click to read button (fullscreen or onyumpu) | fullscreen | | ------------------------ | -------- | ------ | ------------------------------------------------------------ | ---------- | | player\_c2r\_type | optional | String | Template style of click to read button (buttonClassic, buttonRounded, iconEye, iconPlay) | buttonClassic | | ----------------- | -------- | ------ | ---------------------------------------------------------------------------------------- | ------------- | | player\_elements\_page\_numbers | optional | String | Display page numbers (y or n) | y | | ------------------------------- | -------- | ------ | ----------------------------- | - | | player\_elements\_logo | optional | String | Display logo (y or n) | y | | ---------------------- | -------- | ------ | --------------------- | - | | player\_elements\_overview | optional | String | Display overview (y or n) | y | | -------------------------- | -------- | ------ | ------------------------- | - | | player\_elements\_search\_embed | optional | String | Display search button in GUI when embedded == true (y or n) | n | | ------------------------------- | -------- | ------ | ----------------------------------------------------------- | - | | player\_elements\_fs\_share | optional | String | Display facebook link (y or n) | y | | --------------------------- | -------- | ------ | ------------------------------ | - | | player\_elements\_fs\_download | optional | String | Display dowload link (y or n) | y | | ------------------------------ | -------- | ------ | ----------------------------- | - | | player\_elements\_fs\_print | optional | String | Display link to print the magazine (y or n) | y | | --------------------------- | -------- | ------ | ------------------------------------------- | - | | player\_elements\_fs\_recom | optional | String | Display recommended (y or n) | y | | --------------------------- | -------- | ------ | ---------------------------- | - | {% tabs %} {% tab title="curl" %} Example: ``` curl -X PUT -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" -d "id=zKtHE23d6R0qT1rf" -d "document_id=11199" -d "type=1" -d "outline_color=0000000" -d "width=800" -d "outline_size=5" -d "background_color=CCCCCC" -d "outline_enabled=y" -d "title_font_color=0000000" "https://api.yumpu.com/2.0/embed.json" ``` {% endtab %} {% tab title="PHP" %} Example: ```php require_once('../yumpu.php'); $yumpu = new Yumpu(); $data = array( 'id'=>'zKtHE23d6R0qT1rf', 'document_id' => 11199, 'type' => 1, 'background_color' => 'CCCCCC', 'width' => 800, 'title_font_color' => '0000000', 'outline_color' => '0000000', 'outline_size' => 5, 'outline_enabled' => 'y', 'username_enabled' => 'n' ); $putEmbed = $yumpu->putEmbed($data); print_r($putEmbed); ``` {% endtab %} {% tab title="JavaScript" %} Example: ```javascript var yumpu = require('yumpu'); yumpu.setToken('yourToken'); var parameters = { id: 'zKtHE23d6R0qT1rf', document_id: '11199', type: 1, width: 800, outline_enabled: 'y', outline_size: '5', outline_color: '0000000', title_font_color: '0000000', background_color: 'CCCCCC', }; yumpu.putEmbed(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 = {"id=zKtHE23d6R0qT1rf", "document_id=11199", "type=1", "width=800", "outline_enabled=y", "outline_size=5", "outline_color=0000000", "title_font_color=0000000", "background_color=CCCCCC"}; System.out.println(y.putEmbed(params)); ``` {% endtab %} {% endtabs %} Whatever language you are using, the result will be the same. ```javascript { "embed": { "id": "zKtHE23d6R0qT1rf", "user_id": 10000, "document_id": "11199", "type": "1", "create_date": "2014-12-03 10:57:49", "code": "iframe", "settings": { "background_color": "CCCCCC", "fullscreen_background_color": "253139", "height": "580", "outline_color": "000000", "outline_enabled": "1", "outline_size": "5", "page_view": "double_page", "player_autoflip_enabled": "2", "player_c2r_destination": "fullscreen", "player_c2r_enabled": "1", "player_c2r_text": "Click to read", "player_c2r_type": "buttonClassic", "player_mobile_enabled": "1", "player_type": "2", "start_page": "1", "text_font_style": "off", "text_font_weight": "off", "title_font_color": "000000", "title_font_family": "ABeeZee:regular:latin", "title_font_size": "14", "title_font_style": "off", "title_font_weight": "off", "username_enabled": "1", "width": "800" }, "update_date": "2014-12-16 11:28:37" }, "state": "success", "completed_in": "0.4333" } ```