updateBook

This action allows you to update a publication's properties.

info

The API key must have access rights to publish.

Request

Name		Type	Description
apikey	Required	string	API public key
signature	Required	string	Signature of the request.
expires		timestamp	UNIX timestamp for request expiration (GMT)
output		string	Format of the response. Either XML (default), JSON or PHP
book_id	Required	string	Unique publication ID
name		string	Title of the publication. If not present, the filename will be used
description		string	Description of the publication. If not present, the first page's text will be used
date		date	Date of the publication for DRM management (YYYY-MM-DD)
is_published		boolean	Activation status. Either 0 (disabled) or 1 (enabled)
publishing_mode		integer	Access to the publication. Either 1 (public) or 2 (private)
publish_date		datetime	Date and time (UTC) of the publication scheduled publishing (YYYY-MM-DD HH:MM:SS).
private_url		boolean	Use a private URL. Either 0 (disabled) or 1 (enabled)
view		string	Default viewing mode. Either book, slide, scroll
subscribe		integer	Allow subscribers' access. Either 0 (disabled) or 1 (enabled)
comment		integer	Comments behavior. Either 0 (disabled), 1 (moderate all) or 4 (accept all)
download		integer	Download behavior. Either 0 (disabled) or 2 (everyone)
print		integer	Print behavior. Either 0 (disabled) or 2 (everyone)
share		integer	Share menu. Either 0 (disabled), 1 (enabled). Enabled by default
adult		integer	Restrict access to adults. Either 0 (no) or 1 (yes)
direction		integer	Reading direction. Either 0 (left-to-right) or 1 (right-to-left)
license		string	License. Either <empty> (traditional copyright) or pd (public domain), by, by_nc, by_nc_nd, by_nc_sa, by_nd or by_sa (Creative Commons)
skin_url		string	Custom skin URL. Must be an absolute URL
logo_url		string	Custom logo URL. Must be an absolute URL
logo_link_url		string	Custom logo link URL. Must be an absolute URL
background_url		string	Custom background URL. Must be an absolute URL
music		integer	Background music mode. Either 0 (loop forever), 1 (play only once)
music_url		string	Custom background music URL. Must be an absolute URL
sfx		integer	Play sound effects like page flipping. Either 0 (disabled) or 1 (enabled)
sfx_url		string	Custom page flipping sound URL. Must be an absolute URL

Response

This method returns a Publication.

Name	Type	Description
ID	string	ID of the publication
AccountID	integer	Publication's owner account ID (should be your account ID)
SubscriptionID	integer	Publication's owner subscription ID
Name	string	Title of the publication
Description	string	Description of the publication
Status	string	Conversion status of the publication. Either QUEUE (waiting to be converted), PROCESS (processing document), STORE (converting document), ERROR (error during conversion) or DONE (publication ready)
IsPublished	integer	Sends 1 if the publication is published and 0 if not
IsPrivate	integer	Sends 1 if the publication is private and 0 if not
AuthID	string	Authentication parameter for private URLs (authid)
AllowMini	integer	Sends 1 if the publication allows access to the miniCalaméo and 0 if not
Pages	integer	Number of pages of the publication
Width	integer	Width of a page of the publication
Height	integer	Height of a page of the publication
Views	integer	Number of views of the publication
Downloads	integer	Number of downloads of the publication
Comments	integer	Number of comments of the publication
Favorites	integer	Number of favorites from the publication
Date	date	Reference date of the publication
Creation	datetime	Date of creation of the publication
Publication	datetime	Scheduled date of the publication (UTC)
Modification	datetime	Date of the last modification of the publication
PosterUrl	string	Absolute URL for the publication's larger cover
PictureUrl	string	Absolute URL for the publication's cover
ThumbUrl	string	Absolute URL for the publication's thumbnail
PublicUrl	string	Absolute URL for the publication's overview
ViewUrl	string	Absolute URL for the publication's reading page

Example response

JSON

{
  "response": {
    "status": "ok",
    "version": 2,
    "requestid": "lACcQM",
    "requests": 205,
    "content": {
      "ID": "0045168254f0132f6cf5f",
      "SubscriptionID": 4540112,
      "AccountID": 4516825,
      "Name": "Guided Tour EN",
      "Description": "www.calameo.com CALAMÉO GUIDED TOUR ENGLISH",
      "Category": "MISC",
      "Format": "MISC",
      "Dialect": "en",
      "Status": "DONE",
      "IsPublished": 1,
      "IsPrivate": 1,
      "AuthID": "LTDf9GwGH9bl",
      "AllowMini": 1,
      "Date": "2015-10-16",
      "Pages": 12,
      "Width": 595,
      "Height": 841,
      "Views": 0,
      "Downloads": 0,
      "Comments": 0,
      "Favorites": 0,
      "PosterUrl": "https://i.calameoassets.com/151016113106-69d5960ce53f69b75910e802001e6adf/large.jpg",
      "PictureUrl": "https://i.calameoassets.com/151016113106-69d5960ce53f69b75910e802001e6adf/thumb.jpg",
      "ThumbUrl": "https://i.calameoassets.com/151016113106-69d5960ce53f69b75910e802001e6adf/p1.jpg",
      "PublicUrl": "https://www.calameo.com/books/0045168254f0132f6cf5f?authid=LTDf9GwGH9bl",
      "ViewUrl": "https://www.calameo.com/read/0045168254f0132f6cf5f?authid=LTDf9GwGH9bl",
      "Creation": "2015-10-16 11:31:06",
      "Modification": "2015-10-16 11:31:51"
    }
  }
}