Create document folder

The CreateDocumentFolder method creates a new folder in which to store documents and files (this is separate to the image manager).

The full document folder tree can be obtained using GetDocumentFolders and documents can be uploaded using UploadDocument. Note that multiple folders with the same name can be created, and that on creation document folder names will be stripped of non-standard characters.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser‑908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
parentFolderId	integer	This is the identifier of the parent folder in which this new folder should be created. The root folder has the ID of 0 (zero).	required
name	string	The name for your new document folder.	required

Return values

This will return the newly updated document folder tree.

id	integer	The identifier for the root document folder.
name	string	The name for the root document folder.
childFolders		An array of APIDocumentFolder objects, each consisting of id, name and childFolders. If a folder has no children it will return <ChildFolders xsi:nil="true" />.

Error responses

ERROR_DOCUMENT_PARENTFOLDERDOESNOTEXIST
ERROR_DOCUMENT_PARENTFOLDERDELETED
ERROR_DOCUMENT_NAMEINVALID
ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/CreateDocumentFolder"

Sample request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/CreateDocumentFolder"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateDocumentFolder xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <parentFolderId>int</parentFolderId>
      <name>string</name>
    </CreateDocumentFolder>
  </soap:Body>
</soap:Envelope>

Sample response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateDocumentFolderResponse xmlns="http://apiconnector.com">
      <CreateDocumentFolderResult>
        <Id>int</Id>
        <ParentId>int</ParentId>
        <Name>string</Name>
        <ChildFolders>
          <APIDocumentFolder>
            <Id>int</Id>
            <ParentId>int</ParentId>
            <Name>string</Name>
            <ChildFolders xsi:nil="true" />
          </APIDocumentFolder>
          <APIDocumentFolder>
            <Id>int</Id>
            <ParentId>int</ParentId>
            <Name>string</Name>
            <ChildFolders xsi:nil="true" />
          </APIDocumentFolder>
        </ChildFolders>
      </CreateDocumentFolderResult>
    </CreateDocumentFolderResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates