Start export

/data/v2/projects/{projectToken}/exports/{export_id}/start

Trigger an existing export.

Use to start an export with id corresponding to the export_id.

Please note that the export must NOT be running (repeated), as opposed to Imports. If the type of the export is repeated, the route responds with status code 400 and an error message.

Also note that when interpreting the dynamic filenames, scheduled export run matters, not the actual time of the export run.

Definition

Authorization

In this API call you must use the following authorization access and permissions:

Available access typePermissions needed
Private accessExports > Allow trigger exports

Read more about:

Path parameters

ParameterTypeDescriptionRequired
projectTokenstringThe ID of your project.Required
export_idstringThe ID of an existing import in your project.Required

Header

ParameterTypeDescriptionRequired
authorizationstringUsed for authentication. Read more in the Authentication section.Required
content-typestringapplication/json

Note that if you are sending this request without a body, the header must not contain content-type: application/json.
Required if body is not empty.

Limitations

  • The export must NOT be running (repeated).
Language
Click Try It! to start a request and see the response here!