Buttondown logo

Creating an export

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/exports"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}

response = requests.request("POST", url, headers=headers)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "collections": [
        "subscribers"
    ],
    "parameters": null,
    "format": "csv",
    "columns": null,
    "id": "exp_29fxqcmrkp969vzttksexvmvr8",
    "creation_date": "2019-08-24T14:15:22",
    "url": "https://s3.amazonaws.com/buttondown-exports/basic-export.csv",
    "completion_date": "2019-08-24T15:15:22",
    "status": "ready"
}

Body parameters

All parameters are optional unless explicitly specified.

collections

Type
ExportCollection[] · required
Description

The collections of objects to export.

parameters

Type
object
Description

Parameters to pass to the exporter. These are specific to the collection and format, and constrain the export.

format

Type
ExportFormat
Description

The format of the export files.

columns

Type
array
Description

If provided, the export will only include these columns.

Error codes

This endpoint may return the following error codes. See the error codes reference for more details about error handling.

Error CodeDescription
collection_empty_invalidYou must pass in at least one collection to export.
columns_empty_invalidYou must pass in at least one column to export; otherwise, omit the parameter entirely.
columns_invalidYou passed in at least one column that is not valid for the collection you're exporting.
Buttondown logo

Creating an export

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/exports"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}

response = requests.request("POST", url, headers=headers)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "collections": [
        "subscribers"
    ],
    "parameters": null,
    "format": "csv",
    "columns": null,
    "id": "exp_29fxqcmrkp969vzttksexvmvr8",
    "creation_date": "2019-08-24T14:15:22",
    "url": "https://s3.amazonaws.com/buttondown-exports/basic-export.csv",
    "completion_date": "2019-08-24T15:15:22",
    "status": "ready"
}

Body parameters

All parameters are optional unless explicitly specified.

collections

Type
ExportCollection[] · required
Description

The collections of objects to export.

parameters

Type
object
Description

Parameters to pass to the exporter. These are specific to the collection and format, and constrain the export.

format

Type
ExportFormat
Description

The format of the export files.

columns

Type
array
Description

If provided, the export will only include these columns.

Error codes

This endpoint may return the following error codes. See the error codes reference for more details about error handling.

Error CodeDescription
collection_empty_invalidYou must pass in at least one collection to export.
columns_empty_invalidYou must pass in at least one column to export; otherwise, omit the parameter entirely.
columns_invalidYou passed in at least one column that is not valid for the collection you're exporting.