HomeUsing the Platform APIPlatform API Reference

collections.addDoc

This method adds a document to an existing collection. Will return a blank OK response object if successful.

Parameters

NameTypeDescription
doc_idinteger(required)
collection_idinteger(required)The id of the collection. This can be obtained with a call to docs.getCollections.
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.

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.
650Invalid parameter value
651The document does not have suitable permissions for the collection.
653The document is already in the specified collection.

Back to Platform API Reference

scribd