HomeUsing the Platform APIPlatform API Reference

docs.changeSettings

This method updates the meta-data for existing documents. Only send arguments for fields you would like to overwrite. Will return a blank response object if succesful

Parameters

NameTypeDescription
doc_idslist of integers, comma separated(required)A list of document IDs corresponding to documents to be updated. You can of course pass just one document ID here, in which case it will do a single update. But you can also pass a comma-separated list (no spaces) to do a bulk update.
isbnstring(optional)
titlestring(optional)
descriptionstring(optional)
access["public", "private"](optional)Default: "public".
license["by", "by-nc", "by-nc-nd", "by-nc-sa", "by-nd", "by-sa", "c", "pd"](optional)Default: "by-nc". See Wikipedia:Creative_Commons_License. "c" is traditional copyright. "pd" is public domain.
category_idinteger(optional)ID of a category. See docs.getCategories for a list of categories.
tagscsv(optional)Tags should be sent as a comma-delimited list, e.g. "ebook, ruby on rails, software". Multiple-word tags are allowed. The characters colon (:), semi-colon (;), underscore (_), quote ('), double quote ("), backslash (\), and hyphen (-) are stripped from tag text. All tags are downcased for internal representation.
download_formats["pdf", "text", "original"](optional)A comma-delimited list of download formats or empty to disable downloads.
authorstring(optional)
publisherstring(optional)
when_publishedstring(optional)The date this document was originally published
editionstring(optional)
disable_select_text{0, 1}(optional)If this is set to 1, the text selection tool will be disabled. The default is 0.
disable_related_docs{0, 1}(optional)If this is set to 1, the related documents panel will not be shown. The default is 0.
api_keystring(required)API key assigned to your account.
api_sigstring(optional)MD5 hash of the active request and your secret key. This is an optional security measure. See the signing documentation for more info.
session_keystring(optional)A session key for a signed in user. If this parameter is provided, your application will carry out actions on behalf of the signed in user corresponding to the session key. Otherwise, your application will carry out actions on behalf of the user account associated with the API account. See the authentication documentation for more information
my_user_idstring(optional)This parameter is intended for sites with their own user authentication system. You can create phantom Scribd accounts that correspond to your users by simply passing the unique identifier you use to identify your own user accounts to my_user_id. If you pass this parameter to an API method, the API will act as if it were executed by the phantom user corresponding to my_user_id. See the authentication documentation for more information.

Document store

page_restriction_type["automatic" (default), "max_pages", "max_percentage", "page_range"](optional)This parameter lets you add additional restrictions to the preview pages that Scribd shows. Scribd will do this automatically, but if you wish, you can set a maximum number of pages to show (max_pages), a maximum percentage of the pages to show (max_percentage), or an explicit page_range such as 1-3,5,8. See the parameters "max_pages", "max_percentage", and "page_range" to actually set the data.
max_pagesinteger(optional)Corresponds to the "max_pages" page_restriction_type. This is the maximum number of pages that will ever be shown in one document preview.
max_percentageinteger(optional)Corresponds to the "max_percentage" page_restriction_type. This is the maximum percentage of the document that will ever be shown in one document preview.
page_rangestring, e.g., 1-3,5,7(optional)Corresponds to the "page_range" page_restriction_type. Any document preview will show at most a subset of these pages.
allow_search_targeting["true", "false"](optional)Allow Scribd to vary the preview pages it shows to target users' search queries. Note that you can still control the pages Scribd shows with the page_restriction_type parameter, which overrides Scribd's search targeting algorithm. Default: "true". Setting this to "false" is NOT recommended.
obfuscate_numbers["false", "true"](optional)Obsolete
allow_search_indexing["true", "false"](optional)If true, major search engines will index the full text of the document which will drive targeted traffic to the document and increase sales. Note that even when true, search engines never receive a human-readable version of the text. Default: true.
pricefloat (9.99)(optional)The price at which the document will be sold.
list_pricefloat (9.99)(optional)Shown in the price box to let purchasers know how much they are saving. A value of 0.00 indicates no list price.

Sample return XML

<?xml version="1.0" encoding="UTF-8"?><rsp stat="ok"></rsp>

Error codes

401Unauthorized
500Internal Server Error. Scribd has been notified about this problem.
601Required parameter missing
607Problem saving settings
611Insufficient permissions to access this document
612Document could not be found
626Invalid link_back_url - must begin with http:// or https://
631Document was not paid document
650Invalid parameter value
660Invalid category ID - must be an integer

Back to Platform API Reference

scribd