API.updateBook - Calaméo Knowledge Base
Not a Calaméo member yet?
Sign up now! It's FREE!
Get the latest news on Calaméo
Follow us on Facebook
Get Calaméo updates in real-time
Follow us on Twitter

API.updateBook

From Calaméo Knowledge Base

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

<toc>

Request

The API key must have the publish access right.
Name Required Type Description
apikey yes string API public key
signature yes string Signature of the request. See How To Sign Your Requests.
expires yes timestamp UNIX timestamp for request expiration (GMT).
output string Format of the response. Either XML (default), JSON or PHP.
book_id yes string Unique publication ID.
category string Category.
format string Format.
dialect string Dialect.
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).
publish_date datetime Date and time (UTC) of the publication scheduled publishing (YYYY-MM-DD HH:MM:SS).
is_published boolean Activation status. Either 0 (disabled) or 1 (enabled).
publishing_mode integer Access to the publication. Either 1 (public) or 2 (private).
private_url boolean Use a private URL. Either 0 (disabled) or 1 (enabled).
view string Default view ing mode. Either book, slide, scroll.
subscribe integer Allow subscribers' access. Either 0 (disabled) or 1 (enabled).
comment integer Comments behaviour. Either 0 (disabled), 1 (moderate all), 2DEPRECATED (moderate all except contacts), 3DEPRECATED (accept only contacts) or 4 (accept all).
download integer Download behaviour. Either 0 (disabled), 1DEPRECATED (only contacts) or 2 (everyone).
print integer Print behaviour. Either 0 (disabled), 1DEPRECATED (only contacts) or 2 (everyone).
share NEW integer Share menu. Either 0 (disabled), 1 (enabled). Enabled by default.
annotation_view DEPRECATED integer Annotation viewing behaviour. Either 0 (disabled), 1 (only contacts) or 2 (everyone).
annotation_add DEPRECATED integer Annotation adding behaviour. Either 0 (disabled), 1 (only contacts) or 2 (everyone).
mini DEPRECATED integer Allow MiniCalaméo. Either 0 (disabled) or 1 (enabled).
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 "manga mode").
license string License. Either <empty> (traditionnal 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.

Note: If any property is missing from the request, its value will not be updated.

Response

Returns a Publication.

Example responses

JSON

{
  response: {
    requestid: ...,
    requests: ...,
    status: ok,
    content: {
      ID: ...,
      AccountID: ...,
      SubscriptionID: ...,
      Name: ...,
      Description: ...,
      Status: ...,
      IsPublished: ...,
      IsPrivate: ...,
      AuthID: ...,
      AllowMini: ...,
      Date: ...,
      Pages: ...,
      Width: ...,
      Height: ...,
      Views: ...,
      Downloads: ...,
      Comments: ...,
      Favorites: ...,
      Creation: ...,
      Modification: ...,
      PictureUrl: ...
      ThumbUrl: ...
      PublicUrl: ...
      ViewUrl: ...
    }
  }
}

Error codes

See the Error Codes.