Back to API references

SOAP API method Export_start


If - for whatever reason - the export cannot be started, false is returned. Otherwise true is returned. The export cannot be started it it is already running, or if the output is in .xls, 'csv' or .txt format (see extension) and fields from more than one collection are linked to the export.


Name Type Description
id * int Unique identifier (id) of the object Export. The method only applies to the export with this id.
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
value boolean

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt