Buttondown logo

Creating an import

Upload a CSV file to create a new import.

This endpoint expects a multipart form data request with:

  • file (required): The CSV file to import.
  • metadata (optional): A JSON string with column mappings. If omitted, Buttondown will auto-detect the source and map columns automatically.

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/imports"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}
files = {
    "file": open("path/to/your/image.jpg", "rb")
}

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

Sample responses

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

{
    "id": "sub_imp_0k28edc3fw896bp4mrhc535z5k",
    "creation_date": "2020-09-29T00:00:00+00:00",
    "type": "subscriber_import",
    "status": "succeeded",
    "source": "substack",
    "label": "subscribers.csv",
    "metadata": {
        "email_column": 0,
        "metadata_columns": {}
    },
    "results": {
        "new_subscribers": 100,
        "updated_subscribers": null,
        "existing_subscribers": 20,
        "reason_to_bad_subscribers": {
            "That email address is invalid.": [
                "email@examplecom"
            ]
        },
        "new_tags": 2
    }
}

Body parameters

All parameters are optional unless explicitly specified.