BUbuttondown
Imports

Update Import

Changed on

Update an import's properties

patch/imports/{id}

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/imports/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

Request body

labelstring nullable

An optional label for the import.

metadataobject nullable

Metadata about the import, such as detected column mappings.

source'bare' | 'beehiiv' | 'buttondown' | 'custom' | 'flodesk' | 'ghost' | 'google' | 'mailchimp' | 'mailerlite' | 'memberful' | 'pencilbooth' | 'sender_dot_net' | 'sendy' | 'shopify' | 'sparkloop' | 'squarespace' | 'standard' | 'substack' | 'tinyletter'

An enumeration.

status'in_progress' nullable

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

Example request

{
  "label": "June 2025 migration",
  "metadata": {
    "email_column": 0,
    "metadata_columns": {
      "name": 1
    }
  },
  "status": "in_progress"
}

Response

OK

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

The date and time at which the object was first created.

type'subscriber_import' required

An enumeration.

status'failed' | 'in_progress' | 'no_op' | 'not_started' | 'succeeded' | 'validating' required

An enumeration.

source'bare' | 'beehiiv' | 'buttondown' | 'custom' | 'flodesk' | 'ghost' | 'google' | 'mailchimp' | 'mailerlite' | 'memberful' | 'pencilbooth' | 'sender_dot_net' | 'sendy' | 'shopify' | 'sparkloop' | 'squarespace' | 'standard' | 'substack' | 'tinyletter' required

An enumeration.

labelstring nullable

An optional label for the import.

metadataobject

Metadata about the import, such as detected column mappings.

Changes