Buttondown logo

Updating an import

Sample requests

These sample requests are autogenerated by the OpenAPI spec. This endpoint requires one or more parameters in the URL: those are offset in curly-braces.

import requests

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

response = requests.request("PATCH", 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.

{
    "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.

label

Type
string
Description

An optional label for the import.

metadata

Type
object
Description

Metadata about the import, such as detected column mappings.

status

Type
ImportStatus
Description

The status of the import. Set to 'in_progress' to begin executing the import.