Create folder

Use this method to create a new folder.

Method Name: folder.add

Arguments: sid, name, folder_group, description, exclude_quotes, add_to_index, exclude_biblio, exclude_phrases, exclude_small_matches, exclude_abstracts, exclude_methods

Returns: sid, api_status, response_timestamp

Errors: Returns an error message if an invalid folder group is specified

Message: Returns a message on folder creation success, no message on errors

Example Request

<?xml version=”1.0” encoding=”UTF-8”?><methodCall> <methodName>folder.add</methodName> <params><param> <value><struct> <member> <name>sid</name> <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value> </member> <member> <name>folder_group</name> <value><int>123</int></value> </member> <member> <name>name</name> <value><string>6016_testfolder_773</string></value> </member> <member> <name>description</name> <value><string>API client test folder</string></value> </member> <member> <name>exclude_quotes</name> <value><boolean>1</boolean></value> </member> </struct></value> </param></params></methodCall>

Example Response 

<struct> <member> <name>sid</name> <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value> </member> <member> <name>messages</name> <value><array><data> <value><string>Folder created</string></value> </data></array></value> </member> <member> <name>api_status</name> <value><int>200</int></value> </member> <member> <name>id</name> <value><int>262</int></value></member></struct>

Thank you! Your feedback will help us to improve this guide.

Was this page helpful?


We're sorry to hear that

If you have the time, we'd love to know how we could improve it.

Need to contact a human?

Get in touch