Buttondown · Example Payload
Buttondown Enums
AnalyticsAutomationsEmailMarkdownNewslettersPaid SubscriptionsSoftware-as-a-ServiceSubscribersWebhookSegmentationDeveloper ToolsMarketing
Buttondown Enums is an example object payload from Buttondown, with 48 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
ArchivalModeAutomationActionTypeAccessLevelAutomationStatusBulkActionStatusBulkActionTypeCreateExportErrorCodeCreateNewsletterErrorCodeCommentStatusEmailCommentingModeEmailCreationErrorCodeEmailListErrorCodeEmailSourceEmailStatusEmailTypeExportCollectionExportFormatExportStatusImportSourceImportStatusImportTypeExternalEventTypeExternalFeedAutomationBehaviorExternalFeedAutomationCadenceExternalFeedAutomationStatusExternalFeedItemStatusInvitationStatusListSubscribersErrorCodeNewsletterEmailTemplateOperatorSubscriberSourceSubscriberTypeSubscriberUndeliverabilityReasonSurveyResponseCadenceSurveyInputTypeSurveyStatusUpdateSubscriberErrorCodeTagErrorCodeWebhookStatusEmailSuppressionReasonNewsletterAnnouncementBarVisibilityNewsletterArchiveThemeNewsletterAuditingModeNewsletterLocaleHostingDomainStatusSendingDomainStatusAdvertisingSlotStatusSnippetMode
Example Payload
{
"ArchivalMode": {
"archive_only": {
"description": "This email is visible in the archive to everyone, but is not email content (e.g. an imported blog post) and is never sent or shown in email-rendering contexts.",
"name": "Archive only",
"variant": "info"
},
"disabled": {
"description": "This email is not visible in the archive.",
"name": "Disabled",
"variant": "info"
},
"enabled": {
"description": "This email is visible in the archive to everyone.",
"name": "Enabled",
"variant": "info"
},
"enabled_for_paid_subscribers": {
"description": "This email is visible in the archive to paid subscribers only.",
"name": "Enabled for paid subscribers",
"variant": "info"
},
"enabled_for_subscribers": {
"description": "This email is visible in the archive to subscribers only.",
"name": "Enabled for subscribers",
"variant": "info"
}
},
"AutomationActionType": {
"add_metadata": {
"description": "Add metadata to a subscriber.",
"name": "Apply metadata",
"variant": "info"
},
"add_tags": {
"description": "Add tags to a subscriber.",
"name": "Add tags",
"variant": "info"
},
"change_email_address": {
"description": "Change the email address of a subscriber.",
"name": "Change email address",
"variant": "info"
},
"create_arena_post": {
"description": "Posts a block to a specific Arena channel. See our [Are.na integration docs](https://docs.buttondown.com/arena) for more details.",
"name": "Create Arena post",
"variant": "info"
},
"create_bluesky_post": {
"description": "Create a Bluesky post. See our [Bluesky integration docs](https://docs.buttondown.com/bsky) for more details.",
"name": "Create Bluesky post",
"variant": "info"
},
"create_export": {
"description": "Create an export.",
"name": "Create export",
"variant": "info"
},
"create_gift_subscriber": {
"description": "Create a gift subscriber based on metadata from the triggering event.",
"name": "Create gift subscriber",
"variant": "info"
},
"create_linkedin_post": {
"description": "Create a LinkedIn post. See our [LinkedIn integration docs](https://docs.buttondown.com/linkedin) for more details.",
"name": "Create LinkedIn post",
"variant": "info"
},
"create_mastodon_post": {
"description": "Create a Mastodon post. See our [Mastodon integration docs](https://docs.buttondown.com/mastodon) for more details.",
"name": "Create Mastodon post",
"variant": "info"
},
"create_subscriber": {
"description": "Create a new subscriber.",
"name": "Create subscriber",
"variant": "info"
},
"create_tumblr_post": {
"description": "Create a Tumblr post. See our [Tumblr integration docs](https://docs.buttondown.com/tumblr) for more details.",
"name": "Create Tumblr post",
"variant": "info"
},
"create_twitter_post": {
"description": "Create a Twitter post. See our [Twitter integration docs](https://docs.buttondown.com/twitter) for more details.",
"name": "Create Twitter post",
"variant": "info"
},
"forward_reply": {
"description": "Forward the reply to a given recipient.",
"name": "Forward reply",
"variant": "info"
},
"gift_premium_subscription": {
"description": "Gift a premium subscription to a subscriber.",
"name": "Gift premium subscription",
"variant": "info"
},
"remove_metadata": {
"description": "Remove metadata fields from a subscriber.",
"name": "Remove metadata",
"variant": "info"
},
"remove_tags": {
"description": "Remove tags from a subscriber.",
"name": "Remove tags",
"variant": "info"
},
"send_discord_invitation": {
"description": "Send a Discord invitation to a subscriber.",
"name": "Send Discord invitation",
"variant": "info"
},
"send_email": {
"description": "Send an email to a subscriber.",
"name": "Send email",
"variant": "info"
},
"send_github_invitation": {
"description": "Send a GitHub invitation to a subscriber.",
"name": "Send GitHub invitation",
"variant": "info"
},
"send_notification": {
"description": "Send a notification to the newsletter author.",
"name": "Send notification",
"variant": "info"
},
"send_post_request": {
"description": "Send a POST request to a specified URL.",
"name": "Send POST request",
"variant": "info"
},
"send_confirmation_reminder": {
"description": "Send a confirmation reminder to a subscriber.",
"name": "Send confirmation reminder",
"variant": "info"
},
"shopify_create_customer": {
"description": "Create a new customer in your Shopify store from a newsletter subscriber.",
"name": "Create Shopify customer",
"variant": "info"
},
"shopify_resubscribe": {
"description": "Resubscribe a subscriber to your Shopify store marketing emails.",
"name": "Resubscribe to Shopify",
"variant": "info"
},
"shopify_set_tags": {
"description": "Set tags for a subscriber in your Shopify store.",
"name": "Set Shopify tags",
"variant": "info"
},
"shopify_unsubscribe": {
"description": "Unsubscribe a subscriber from your Shopify store.",
"name": "Unsubscribe from Shopify",
"variant": "info"
},
"ungift_premium_subscription": {
"description": "Remove a gifted premium subscription from a subscriber.",
"name": "Ungift premium subscription",
"variant": "info"
},
"unsubscribe_subscriber": {
"description": "Unsubscribe a subscriber from your newsletter.",
"name": "Unsubscribe from Buttondown",
"variant": "info"
},
"update_email_type": {
"description": "Update the visibility of an email.",
"name": "Update email visibility",
"variant": "info"
}
},
"AccessLevel": {
"none": {
"description": "No access to this functionality.",
"name": "None",
"variant": "info"
},
"read": {
"description": "Read-only access to this functionality.",
"name": "Read",
"variant": "info"
},
"write": {
"description": "Full read and write access to this functionality.",
"name": "Write",
"variant": "success"
}
},
"AutomationStatus": {
"active": {
"description": "Active.",
"name": "Active",
"variant": "info"
},
"inactive": {
"description": "Inactive.",
"name": "Inactive",
"variant": "warning"
}
},
"BulkActionStatus": {
"failed": {
"description": "The bulk action was unable to be completed. Buttondown is looking into it.",
"name": "Error",
"variant": "error"
},
"in_progress": {
"description": "The bulk action is currently being processed.",
"name": "In progress",
"variant": "info"
},
"not_started": {
"description": "The bulk action has not yet started.",
"name": "Not started",
"variant": "info"
},
"processed": {
"description": "The bulk action has completed.",
"name": "Success",
"variant": "success"
}
},
"BulkActionType": {
"add_notes": {
"description": "Add notes to multiple subscribers in bulk.",
"name": "Add notes",
"variant": "info"
},
"apply_metadata": {
"description": "This action requires two additional parameters within `metadata`: `action` (which can be either `add`, `set`, or `remove`), and `metadata` (the value of the metadata which you'd like to either add or remove to the list of subscribers).",
"name": "Apply metadata (to subscribers)",
"variant": "info"
},
"apply_tags": {
"description": "This action requires two additional parameters within `metadata`: `tag_id` (the ID of the tag which you'd like to either add or remove to the list of subscribers) and `action` (which can be either `add` or `remove`).",
"name": "Apply tags",
"variant": "info"
},
"ban_subscribers": {
"description": "Ban subscribers from your newsletter.",
"name": "Ban subscribers",
"variant": "info"
},
"cancel_stripe_subscriptions": {
"description": "Cancel the Stripe subscriptions for multiple subscribers in bulk.",
"name": "Cancel Stripe subscriptions",
"variant": "info"
},
"change_tags_colors": {
"description": "Change the color of multiple tags in bulk.",
"name": "Change tags colors",
"variant": "info"
},
"delete_attachments": {
"description": "Delete multiple uploaded attachments in bulk.",
"name": "Delete attachments",
"variant": "info"
},
"delete_comments": {
"description": "Delete multiple comments in bulk.",
"name": "Delete comments",
"variant": "info"
},
"delete_emails": {
"description": "Delete multiple emails in bulk.",
"name": "Delete emails",
"variant": "info"
},
"delete_images": {
"description": "Delete multiple uploaded images in bulk.",
"name": "Delete images",
"variant": "info"
},
"delete_inbox_items": {
"description": "Delete multiple inbox items in bulk.",
"name": "Delete inbox items",
"variant": "info"
},
"delete_subscribers": {
"description": "Delete multiple subscribers in bulk.",
"name": "Delete subscribers",
"variant": "info"
},
"delete_survey_responses": {
"description": "Delete multiple survey responses in bulk.",
"name": "Delete survey responses",
"variant": "info"
},
"delete_surveys": {
"description": "Delete multiple surveys in bulk.",
"name": "Delete surveys",
"variant": "info"
},
"delete_tags": {
"description": "Delete multiple tags in bulk.",
"name": "Delete tags",
"variant": "info"
},
"gift_subscribers": {
"description": "Gift premium subscriptions to multiple subscribers in bulk.",
"name": "Gift subscribers",
"variant": "info"
},
"mark_comments_as_active": {
"description": "Mark multiple comments as active.",
"name": "Mark comments as active",
"variant": "info"
},
"mark_comments_as_spammy": {
"description": "Mark multiple comments as spam.",
"name": "Mark comments as spammy",
"variant": "info"
},
"mark_inbox_items_read": {
"description": "Mark multiple inbox items as read.",
"name": "Mark inbox items as read",
"variant": "info"
},
"mark_subscribers_as_not_spammy": {
"description": "Restore the status of multiple subscribers. Their exact type will depend on their history with your newsletter, but in general Buttondown will do the 'right' thing (e.g. restoring their premium subscription if they had one.)",
"name": "Mark subscribers as not spammy",
"variant": "info"
},
"modify_stripe_subscriptions": {
"description": "Modify the Stripe subscriptions for multiple subscribers in bulk.",
"name": "Modify Stripe subscriptions",
"variant": "info"
},
"pause_stripe_subscriptions": {
"description": "Pause or unpause the Stripe subscriptions for multiple subscribers in bulk.",
"name": "Pause Stripe subscriptions",
"variant": "info"
},
"reactivate_subscribers": {
"description": "Reactivate multiple subscribers in bulk.",
"name": "Reactivate subscribers",
"variant": "info"
},
"rename_metadata": {
"description": "Rename multiple metadata fields in bulk. This action requires two additional parameters within `metadata`: `rename_mapping` field and an `ids` field (either a list of specific subscriber IDs for whom you want to rename metadata, or `all`).",
"name": "Rename metadata",
"variant": "info"
},
"replay_events": {
"description": "Replay multiple events in bulk.",
"name": "Replay events",
"variant": "info"
},
"resubscribe_subscribers": {
"description": "Resubscribe multiple unsubscribed subscribers in bulk.",
"name": "Resubscribe subscribers",
"variant": "info"
},
"send_emails": {
"description": "This action requires one additional parameter within `metadata`: `email_id` (the ID of the email which you'd like to send).",
"name": "Send emails",
"variant": "info"
},
"send_reminders": {
"description": "Send reminders to multiple subscribers in bulk.",
"name": "Send reminders",
"variant": "info"
},
"unban_subscribers": {
"description": "Unban multiple subscribers in bulk.",
"name": "Unban subscribers",
"variant": "info"
},
"ungift_subscribers": {
"description": "Remove gifted premium subscriptions from multiple subscribers in bulk.",
"name": "Ungift subscribers",
"variant": "info"
},
"unsubscribe_subscribers": {
"description": "Unsubscribe multiple subscribers in bulk.",
"name": "Unsubscribe subscribers",
"variant": "info"
},
"update_archival_modes": {
"description": "Update the archival modes for multiple emails in bulk.",
"name": "Update archival modes",
"variant": "info"
},
"update_commenting_modes": {
"description": "Update the commenting modes for multiple emails in bulk.",
"name": "Update commenting modes",
"variant": "info"
},
"update_email_types": {
"description": "Update the email types for multiple emails in bulk.",
"name": "Update email types",
"variant": "info"
},
"update_survey_statuses": {
"description": "Update the status types for multiple surveys in bulk.",
"name": "Update status types",
"variant": "info"
}
},
"CreateExportErrorCode": {
"collection_empty_invalid": {
"description": "You must pass in at least one collection to export.",
"name": "No collections passed in",
"variant": "error"
},
"columns_empty_invalid": {
"description": "You must pass in at least one column to export; otherwise, omit the parameter entirely.",
"name": "No columns passed in",
"variant": "error"
},
"columns_invalid": {
"description": "You passed in at least one column that is not valid for the collection you're exporting.",
"name": "Invalid columns passed in",
"variant": "error"
}
},
"CreateNewsletterErrorCode": {
"domain_incorrect": {
"description": "The domain is incorrect.",
"name": "Domain incorrect",
"variant": "error"
},
"domain_path": {
"description": "The domain must not include a path.",
"name": "Domain includes path",
"variant": "error"
},
"domain_protocol": {
"description": "The domain must not include a protocol.",
"name": "Domain includes protocol",
"variant": "error"
},
"email_domain_conflicts_with_hosting_domain": {
"description": "The email domain conflicts with the hosting domain.",
"name": "Email domain conflicts with hosting domain",
"variant": "error"
},
"email_domain_contains_at": {
"description": "The email domain must not contain an at-sign.",
"name": "Email domain contains at-sign",
"variant": "error"
},
"email_domain_incorrect": {
"description": "The email domain is incorrect.",
"name": "Email domain incorrect",
"variant": "error"
},
"email_domain_path": {
"description": "The email domain must not include a path.",
"name": "Email domain includes path",
"variant": "error"
},
"email_domain_protocol": {
"description": "The email domain must not include a protocol.",
"name": "Email domain includes protocol",
"variant": "error"
},
"email_domain_used_by_other_account": {
"description": "The email domain is already used by another account.",
"name": "Email domain already in use",
"variant": "error"
},
"invalid_metadata": {
"description": "The metadata contains invalid values.",
"name": "Invalid metadata",
"variant": "error"
},
"username_already_exists": {
"description": "A newsletter already exists with that username.",
"name": "Username already exists",
"variant": "error"
},
"username_malformed": {
"description": "The username is malformed.",
"name": "Username malformed",
"variant": "error"
},
"username_reserved": {
"description": "The username is reserved.",
"name": "Username reserved",
"variant": "error"
},
"username_too_short": {
"description": "The username is too short.",
"name": "Username too short",
"variant": "error"
}
},
"CommentStatus": {
"active": {
"description": "The comment has been approved and is visible.",
"name": "Active",
"variant": "success"
},
"pending": {
"description": "The comment is awaiting moderation.",
"name": "Pending",
"variant": "info"
},
"spammy": {
"description": "The comment has been marked as spam.",
"name": "Spam",
"variant": "error"
}
},
"EmailCommentingMode": {
"disabled": {
"description": "Commenting is disabled for this email.",
"name": "Disabled",
"variant": "info"
},
"enabled": {
"description": "Commenting is enabled for this email.",
"name": "Enabled",
"variant": "info"
},
"enabled_for_paid_subscribers": {
"description": "Commenting is enabled for paid subscribers only.",
"name": "Enabled for paid subscribers",
"variant": "info"
}
},
"EmailCreationErrorCode": {
"body_contains_frontmatter": {
"description": "The email body starts with YAML frontmatter (a `---` delimiter followed by key-value pairs). This is almost always a sign of a bug in your integration rather than intentional email content.",
"name": "Body contains frontmatter",
"variant": "error"
},
"body_invalid": {
"description": "The email body provided is invalid or cannot be parsed.",
"name": "Body invalid",
"variant": "error"
},
"canonical_url_invalid": {
"description": "The canonical URL provided is not a valid URL.",
"name": "Canonical URL invalid",
"variant": "error"
},
"email_duplicate": {
"description": "An email with the same identifiers already exists.",
"name": "Duplicate email",
"variant": "error"
},
"email_not_confirmed": {
"description": "The newsletter owner must confirm their email address before creating emails via the API.",
"name": "Email not confirmed",
"variant": "error"
},
"email_invalid": {
"description": "The email is invalid.",
"name": "Invalid email",
"variant": "error"
},
"pay_per_email_billing_locked": {
"description": "Pay-per-email billing cannot be changed after an email has begun sending.",
"name": "Pay-per-email billing locked",
"variant": "error"
},
"publish_date_invalid": {
"description": "The publish date provided is not valid or is in an incorrect format.",
"name": "Publish date invalid",
"variant": "error"
},
"publish_date_missing": {
"description": "A publish date is required but was not provided.",
"name": "Publish date missing",
"variant": "error"
},
"sending_requires_confirmation": {
"description": "Creating an email with status 'about_to_send' on API version 2026-04-01 or later requires the X-Buttondown-Live-Dangerously header on first use per API key.",
"name": "Sending requires confirmation",
"variant": "error"
},
"slug_invalid": {
"description": "The slug provided is invalid or already in use.",
"name": "Slug invalid",
"variant": "error"
},
"status_invalid": {
"description": "The status provided is not valid.",
"name": "Status invalid",
"variant": "error"
},
"subject_invalid": {
"description": "The subject provided is invalid or missing.",
"name": "Invalid subject",
"variant": "error"
},
"tag_invalid": {
"description": "The tag provided is invalid or does not exist.",
"name": "Invalid tag",
"variant": "error"
}
},
"EmailListErrorCode": {
"creation_date_invalid": {
"description": "The creation date provided is not valid or is in an incorrect format.",
"name": "Creation date invalid",
"variant": "error"
},
"publish_date_invalid": {
"description": "The publish date provided is not valid or is in an incorrect format.",
"name": "Publish date invalid",
"variant": "error"
}
},
"EmailSource": {
"api": {
"description": "This email was created via the API.",
"name": "API",
"variant": "info"
},
"app": {
"description": "This email was created via the Buttondown web app.",
"name": "App",
"variant": "info"
},
"external_feed": {
"description": "This email was created by an external RSS feed.",
"name": "External feed",
"variant": "info"
},
"import": {
"description": "This email was imported from another service.",
"name": "Import",
"variant": "info"
},
"smtp": {
"description": "This email was created by emailing it in to Buttondown (post by email / SMTP).",
"name": "SMTP",
"variant": "info"
}
},
"EmailStatus": {
"about_to_send": {
"description": "This email has been queued to send out to subscribers, and will be sent automatically within a few minutes.\n\nIf you're seeing that an email you just sent out is 'stuck' here, worry not — Buttondown sometimes takes a little bit longer to send out emails to ensure deliverability, but once it's marked as 'about to send' it will get sent out.",
"name": "About to send",
"variant": "info"
},
"deleted": {
"description": "This email has been deleted, and is no longer visible in your web archives.",
"name": "Deleted",
"variant": "warning"
},
"draft": {
"description": "Draft emails are only visible to you and are not sent out to subscribers.",
"name": "Draft",
"variant": "info"
},
"errored": {
"description": "This email has encountered an error while sending out to subscribers, and is not visible in your web archives.",
"name": "Errored",
"variant": "error"
},
"imported": {
"description": "This email was imported from another service, and is visible in your web archives if enabled.",
"name": "Imported",
"variant": "info"
},
"in_flight": {
"description": "This email is currently being sent out to subscribers, and is visible in your web archives if enabled.\n\nSome emails, especially those with large subscriber lists, may take a while to send out — Buttondown sends emails out in batches to ensure deliverability, so if you're seeing an email 'stuck' here, it's because our systems have detected that that's the optimal way to reach your subscribers.",
"name": "In flight",
"variant": "info"
},
"managed_by_rss": {
"description": "This email was created by an external feed, and has not yet been finalized and sent out by Buttondown.",
"name": "Managed by RSS",
"variant": "info"
},
"paused": {
"description": "This email has been paused, and is not visible in your web archives.",
"name": "Paused",
"variant": "warning"
},
"resending": {
"description": "This email is in the process of automatically being resent to subscribers by Buttondown's systems in order to make sure all subscribers have received it.",
"name": "Resending",
"variant": "warning"
},
"scheduled": {
"description": "This email has been scheduled to send out to subscribers at a specific time. This specific time is available on the email as its `publish_date`.",
"name": "Scheduled",
"variant": "info"
},
"sent": {
"description": "This email has been sent out to subscribers, and is visible in your web archives if enabled.",
"name": "Sent",
"variant": "success"
},
"suppressed": {
"description": "This email has been suppressed and is not visible to subscribers.",
"name": "Suppressed",
"variant": "warning"
},
"throttled": {
"description": "This email is in the process of being sent out, but is being intentionally sent slowly to ensure deliverability.",
"name": "Throttled",
"variant": "warning"
},
"transactional": {
"description": "This email is a transactional email used by a core workflow in your newsletter or Automations, and is not visible in your web archives nor sent out to subscribers.",
"name": "Transactional",
"variant": "info"
}
},
"EmailType": {
"archival": {
"description": "Emails that are only available in the archive and not sent to subscribers.",
"name": "Archival",
"variant": "info"
},
"churned": {
"description": "Emails sent specifically to subscribers who were previously premium but have since churned.",
"name": "Churned",
"variant": "info"
},
"free": {
"description": "Free emails are sent out only to subscribers who are not paying for your newsletter (so you can send specific emails to convince them to pay, for instance!)",
"name": "Free",
"variant": "info"
},
"premium": {
"description": "Premium emails are sent out to only paying subscribers (including those with gift subscriptions or on a free trial), and only premium subscribers can view them in online archives.",
"name": "Premium",
"variant": "info"
},
"private": {
"description": "Private emails are sent out to all of your subscribers but are not viewable in your web archives.",
"name": "Private",
"variant": "info"
},
"public": {
"description": "Public emails are sent out to all of your subscribers and are available in your web archives.",
"name": "Public",
"variant": "info"
}
},
"ExportCollection": {
"comments": {
"name": "Comments",
"variant": "info"
},
"conversations": {
"name": "Conversations",
"variant": "info"
},
"emails": {
"name": "Emails",
"variant": "info"
},
"events": {
"name": "Events",
"variant": "info"
},
"images": {
"name": "Images",
"variant": "info"
},
"mentions": {
"name": "Mentions",
"variant": "info"
},
"referrals": {
"name": "Referrals",
"variant": "info"
},
"requests": {
"name": "API Requests",
"variant": "info"
},
"stripe_charges": {
"name": "Stripe Charges",
"variant": "info"
},
"stripe_customers": {
"name": "Stripe Customers",
"variant": "info"
},
"stripe_prices": {
"name": "Stripe Prices",
"variant": "info"
},
"stripe_products": {
"name": "Stripe Products",
"variant": "info"
},
"stripe_subscriptions": {
"name": "Stripe Subscriptions",
"variant": "info"
},
"subscribers": {
"name": "Subscribers",
"variant": "info"
},
"surveys": {
"name": "Surveys",
"variant": "info"
}
},
"ExportFormat": {
"csv": {
"description": "Comma-separated values.",
"name": "CSV",
"variant": "info"
},
"json": {
"description": "JavaScript Object Notation.",
"name": "JSON",
"variant": "info"
}
},
"ExportStatus": {
"error": {
"description": "The export was unable to be completed. Buttondown is looking into it.",
"name": "Error",
"variant": "error"
},
"in_progress": {
"description": "The export is currently being processed.",
"name": "In progress",
"variant": "info"
},
"not_started": {
"description": "The export has not yet started.",
"name": "Not started",
"variant": "info"
},
"ready": {
"description": "The export has completed.",
"name": "Ready",
"variant": "success"
}
},
"ImportSource": {
"bare": {
"description": "A single-column CSV containing only email addresses.",
"name": "Bare",
"variant": "info"
},
"beehiiv": {
"description": "A CSV exported from Beehiiv.",
"name": "Beehiiv",
"variant": "info"
},
"buttondown": {
"description": "A CSV exported from Buttondown.",
"name": "Buttondown",
"variant": "info"
},
"custom": {
"description": "A CSV that requires manual column mapping.",
"name": "Custom",
"variant": "info"
},
"flodesk": {
"description": "A CSV exported from Flodesk.",
"name": "Flodesk",
"variant": "info"
},
"ghost": {
"description": "A CSV exported from Ghost.",
"name": "Ghost",
"variant": "info"
},
"google": {
"description": "A CSV exported from Google.",
"name": "Google",
"variant": "info"
},
"mailchimp": {
"description": "A CSV exported from Mailchimp.",
"name": "Mailchimp",
"variant": "info"
},
"mailerlite": {
"description": "A CSV exported from MailerLite.",
"name": "MailerLite",
"variant": "info"
},
"memberful": {
"description": "A CSV exported from Memberful.",
"name": "Memberful",
"variant": "info"
},
"pencilbooth": {
"description": "A CSV exported from Pencilbooth.",
"name": "Pencilbooth",
"variant": "info"
},
"sender_dot_net": {
"description": "A CSV exported from Sender.net.",
"name": "Sender.net",
"variant": "info"
},
"sendy": {
"description": "A CSV exported from Sendy.",
"name": "Sendy",
"variant": "info"
},
"shopify": {
"description": "A CSV exported from Shopify.",
"name": "Shopify",
"variant": "info"
},
"sparkloop": {
"description": "A CSV exported from SparkLoop.",
"name": "SparkLoop",
"variant": "info"
},
"squarespace": {
"description": "A CSV exported from Squarespace.",
"name": "Squarespace",
"variant": "info"
},
"standard": {
"description": "A CSV with standard column names that was auto-mapped.",
"name": "Standard",
"variant": "info"
},
"substack": {
"description": "A CSV exported from Substack.",
"name": "Substack",
"variant": "info"
},
"tinyletter": {
"description": "A CSV exported from TinyLetter.",
"name": "TinyLetter",
"variant": "info"
}
},
"ImportStatus": {
"failed": {
"description": "The import encountered an error and could not be completed.",
"name": "Failed",
"variant": "error"
},
"in_progress": {
"description": "The import is currently being processed.",
"name": "In progress",
"variant": "info"
},
"not_started": {
"description": "The import has been created but processing has not yet begun.",
"name": "Not started",
"variant": "info"
},
"succeeded": {
"description": "The import completed successfully.",
"name": "Succeeded",
"variant": "success"
},
"validating": {
"description": "The import is being validated before processing.",
"name": "Validating",
"variant": "info"
}
},
"ImportType": {
"subscriber_import": {
"description": "An import of subscribers from a CSV file.",
"name": "Subscriber import",
"variant": "info"
}
},
"ExternalEventType": {
"advertising_slot.inquiry": {
"description": "Whenever a sponsor submits an inquiry for an advertising slot.",
"name": "advertising_slot.inquiry"
},
"advertising_slot.purchased": {
"description": "Whenever an advertising slot in your newsletter is purchased.",
"name": "advertising_slot.purchased"
},
"automation.invoked": {
"description": "Whenever an automation is manually invoked (e.g. by a webhook or API call).",
"name
# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/buttondown/refs/heads/main/examples/buttondown-enums.json