enums.json

{
  "CreateExportErrorCode": {
    "collection_empty_invalid": {
      "variant": "error",
      "name": "No collections passed in",
      "description": "You must pass in at least one collection to export."
    }
  },
  "UpdateTagErrorCode": {
    "name_already_exists": {
      "variant": "error",
      "name": "Name already exists",
      "description": "The name of the tag already exists."
    },
    "name_too_long": {
      "variant": "error",
      "name": "Name too long",
      "description": "The name of the tag is too long."
    }
  },
  "SurveyStatus": {
    "active": {
      "variant": "info",
      "name": "Active",
      "description": "Active."
    },
    "inactive": {
      "variant": "warning",
      "name": "Inactive",
      "description": "Inactive."
    }
  },
  "SurveyResponseCadence": {
    "once": {
      "variant": "info",
      "name": "Once",
      "description": "A subscriber can only respond to this survey once."
    },
    "once_per_email": {
      "variant": "info",
      "name": "Once per email",
      "description": "A subscriber can respond to this survey once per email."
    }
  },
  "CreateNewsletterErrorCode": {
    "username_invalid": {
      "variant": "error",
      "name": "Username invalid",
      "description": "The username is invalid."
    },
    "username_already_exists": {
      "variant": "error",
      "name": "Username already exists",
      "description": "A newsletter already exists with that username."
    }
  },
  "CreateSubscriberErrorCode": {
    "email_already_exists": {
      "variant": "error",
      "name": "Email already exists",
      "description": "A subscriber already exists with that email."
    },
    "email_invalid": {
      "variant": "error",
      "name": "Email invalid",
      "description": "The email is invalid."
    },
    "tag_invalid": {
      "variant": "error",
      "name": "Tag invalid",
      "description": "The tag is invalid."
    }
  },
  "ExternalFeedItemStatus": {
    "unprocessed": {
      "name": "Unprocessed",
      "description": "Unprocessed.",
      "variant": "info"
    },
    "irrelevant": {
      "name": "Irrelevant",
      "description": "Items in an RSS feed are marked as irrelevant if they do not have a publish date associated with them or if the publish date came before the RSS feed itself was connected to Buttondown.",
      "variant": "warning"
    },
    "skipped": {
      "name": "Skipped",
      "description": "Items in an RSS feed are marked as 'skipped' if the RSS feed itself is paused or inactive in Buttondown when the item is processed. To send this item, you must manually process & send it using Buttondown's writing interface.",
      "variant": "info"
    },
    "queued": {
      "name": "Queued",
      "description": "Queued.",
      "variant": "info"
    },
    "processed": {
      "name": "Processed",
      "description": "Processed.",
      "variant": "success"
    },
    "errored": {
      "name": "Errored",
      "description": "Errored.",
      "variant": "error"
    }
  },
  "ExternalFeedAutomationBehavior": {
    "draft": {
      "name": "Create draft",
      "description": "Create a draft email.",
      "variant": "info"
    },
    "emails": {
      "name": "Send email",
      "description": "Send emails to subscribers.",
      "variant": "info"
    }
  },
  "AutomationStatus": {
    "active": {
      "name": "Active",
      "description": "Active.",
      "variant": "info"
    },
    "inactive": {
      "name": "Inactive",
      "description": "Inactive.",
      "variant": "warning"
    }
  },
  "ExternalFeedAutomationStatus": {
    "active": {
      "name": "Active",
      "description": "Active.",
      "variant": "info"
    },
    "inactive": {
      "name": "Inactive",
      "description": "Inactive.",
      "variant": "warning"
    },
    "failing": {
      "name": "Failing",
      "description": "Buttondown cannot retrieve items from this feed. It will continue to attempt to do so until it gives up, at which point the automation will be set to `inactive`.",
      "variant": "error"
    }
  },
  "ExternalFeedAutomationCadence": {
    "every": {
      "name": "Every new item",
      "description": "Act every single time a new item is added to the RSS feed.",
      "variant": "success"
    },
    "weekly": {
      "name": "Weekly",
      "description": "Act every week, compiling a digest of new items.",
      "variant": "info"
    },
    "monthly": {
      "name": "Monthly",
      "description": "Act every month, compiling a digest of new items.",
      "variant": "info"
    }
  },
  "SubscriberSource": {
    "api": {
      "name": "API",
      "variant": "info",
      "description": "Subscriber created by API."
    },
    "import": {
      "name": "Import",
      "variant": "info",
      "description": "This subscriber was imported from another service."
    },
    "organic": {
      "name": "Organic",
      "variant": "info",
      "description": "This subscriber subscribed to your newsletter of their own volition."
    },
    "admin": {
      "name": "Admin",
      "variant": "info",
      "description": "This subscriber was added by a member of Buttondown support staff."
    },
    "user": {
      "name": "User",
      "variant": "info",
      "description": "This subscriber was added by a user with write permissions for subscribers within the Buttondown dashboard."
    }
  },
  "UpdateSubscriberErrorCode": {
    "invalid_tag": {
      "variant": "error",
      "name": "Invalid tag"
    }
  },
  "ListSubscribersErrorCode": {
    "invalid_tag": {
      "variant": "error",
      "name": "Invalid tag"
    }
  },
  "EmailListErrorCode": {},
  "EmailCreationErrorCode": {
    "subject_invalid": {
      "variant": "error",
      "name": "Invalid subject"
    },
    "tag_invalid": {
      "variant": "error",
      "name": "Invalid tag"
    },
    "email_duplicate": {
      "variant": "error",
      "name": "Duplicate email"
    },
    "email_invalid": {
      "variant": "error",
      "name": "Invalid email"
    }
  },
  "EmailStatus": {
    "draft": {
      "variant": "info",
      "name": "Draft",
      "description": "Draft emails are only visible to you and are not sent out to subscribers."
    },
    "about_to_send": {
      "variant": "info",
      "name": "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."
    },
    "scheduled": {
      "variant": "info",
      "name": "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`."
    },
    "in_flight": {
      "variant": "info",
      "name": "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."
    },
    "imported": {
      "variant": "info",
      "name": "Imported",
      "description": "This email was imported from another service, and is visible in your web archives if enabled."
    },
    "managed_by_rss": {
      "variant": "info",
      "name": "Managed by RSS",
      "description": "This email was created by an external feed, and has not yet been finalized and sent out by Buttondown."
    },
    "deleted": {
      "variant": "warning",
      "name": "Deleted",
      "description": "This email has been deleted, and is no longer visible in your web archives."
    },
    "paused": {
      "variant": "warning",
      "name": "Paused",
      "description": "This email has been paused, and is not visible in your web archives."
    },
    "sent": {
      "variant": "success",
      "name": "Sent",
      "description": "This email has been sent out to subscribers, and is visible in your web archives if enabled."
    },
    "errored": {
      "variant": "error",
      "name": "Errored",
      "description": "This email has encountered an error while sending out to subscribers, and is not visible in your web archives."
    }
  },
  "EmailSource": {
    "api": {
      "variant": "info",
      "name": "API",
      "description": "This email was created via the API."
    },
    "import": {
      "variant": "info",
      "name": "Import",
      "description": "This email was imported from another service."
    },
    "app": {
      "variant": "info",
      "name": "App",
      "description": "This email was created via the Buttondown web app."
    },
    "external_feed": {
      "variant": "info",
      "name": "External feed",
      "description": "This email was created by an external RSS feed."
    }
  },
  "EmailType": {
    "public": {
      "variant": "info",
      "name": "Public",
      "description": "Public emails are sent out to all of your subscribers and are available in your web archives."
    },
    "private": {
      "variant": "info",
      "name": "Private",
      "description": "Private emails are sent out to all of your subscribers but are not viewable in your web archives."
    },
    "premium": {
      "variant": "info",
      "name": "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."
    },
    "free": {
      "variant": "info",
      "name": "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!)"
    }
  },
  "ExportCollection": {
    "subscribers": {
      "variant": "info",
      "name": "Subscribers"
    },
    "emails": {
      "variant": "info",
      "name": "Emails"
    },
    "scheduled_emails": {
      "variant": "info",
      "name": "Scheduled emails"
    },
    "drafts": {
      "variant": "info",
      "name": "Drafts"
    },
    "mentions": {
      "variant": "info",
      "name": "Mentions"
    },
    "unsubscribers": {
      "variant": "info",
      "name": "Unsubscribers"
    },
    "events": {
      "variant": "info",
      "name": "Events"
    },
    "referrals": {
      "variant": "info",
      "name": "Referrals"
    },
    "surveys": {
      "variant": "info",
      "name": "Surveys"
    },
    "comments": {
      "variant": "info",
      "name": "Comments"
    },
    "requests": {
      "variant": "info",
      "name": "API Requests"
    },
    "conversations": {
      "variant": "info",
      "name": "Conversations"
    }
  },
  "ExportStatus": {
    "not_started": {
      "variant": "info",
      "name": "Not started",
      "description": "The export has not yet started."
    },
    "in_progress": {
      "variant": "info",
      "name": "In progress",
      "description": "The export is currently being processed."
    },
    "ready": {
      "variant": "success",
      "name": "Ready",
      "description": "The export has completed."
    },
    "error": {
      "variant": "error",
      "name": "Error",
      "description": "The export was unable to be completed. Buttondown is looking into it."
    }
  },
  "ExternalEventType": {
    "subscriber.replied": {
      "name": "subscriber.replied",
      "description": "Whenever a subscriber has replied to one of your emails."
    },
    "subscriber.created": {
      "name": "subscriber.created",
      "description": "Whenever a new subscriber is created."
    },
    "subscriber.unsubscribed": {
      "name": "subscriber.unsubscribed",
      "description": "When a subscriber has manually unsubscribed from your newsletter."
    },
    "subscriber.confirmed": {
      "name": "subscriber.confirmed",
      "description": "When a subscriber has confirmed that they are enrolled in your newsletter. (For newsletters without double opt-in, this event is created immediately after `subscriber.created`.)"
    },
    "subscriber.trial_started": {
      "name": "subscriber.trial_started",
      "description": "When the trial has started for a subscriber. (For newsletters with automatic free trials, this will be created immediately after `subscriber.confirmed`.)"
    },
    "subscriber.trial_ended": {
      "name": "subscriber.trial_ended",
      "description": "When the trial has ended for a subscriber."
    },
    "subscriber.paid": {
      "name": "subscriber.paid",
      "description": "When a subscriber has enrolled in your newsletter's paid offering."
    },
    "subscriber.churned": {
      "name": "subscriber.churned",
      "description": "When a subscriber has unenrolled from your newsletter's paid offering."
    },
    "subscriber.clicked": {
      "name": "subscriber.clicked",
      "description": "When a subscriber has clicked a link in one of your emails."
    },
    "subscriber.updated": {
      "name": "subscriber.updated",
      "description": "When a subscriber's notes or metadata has changed."
    },
    "email.created": {
      "name": "email.created",
      "description": "Whenever a new email is created and begins delivery. Note that event happens immediately before the emails themselves are sent."
    },
    "email.sent": {
      "name": "email.sent",
      "description": "Whenever an email has finished its delivery. Note that event happens immediately after all emails have been sent, but some email events may not have finished processing."
    },
    "email.deleted": {
      "name": "email.deleted",
      "description": "Whenever an email has been deleted."
    },
    "email.status.changed": {
      "name": "email.status.changed",
      "description": "Whenever an email's status has changed (e.g. from 'draft' to 'sent'.) The `metadata` field will contain the previous and new statii in 'old_value' and 'new_value' respectively."
    },
    "memberful.subscription.created": {
      "name": "memberful.subscription.created",
      "description": "Whenever a new subscription is created in Memberful."
    },
    "memberful.subscription.deleted": {
      "name": "memberful.subscription.deleted",
      "description": "Whenever a subscription is deleted in Memberful."
    },
    "memberful.member.updated": {
      "name": "memberful.member.updated",
      "description": "Whenever a member changes their email address in Memberful."
    },
    "stripe.subscription.activated": {
      "name": "stripe.subscription.activated",
      "description": "Whenever a subscription is activated in Stripe."
    },
    "stripe.subscription.churning": {
      "name": "stripe.subscription.churning",
      "description": "Whenever a subscription is churning in Stripe."
    },
    "stripe.subscription.deactivated": {
      "name": "stripe.subscription.deactivated",
      "description": "Whenever a subscription is deactivated in Stripe."
    },
    "stripe.customer.updated": {
      "name": "stripe.customer.updated",
      "description": "Whenever a customer changes their email address in Stripe."
    },
    "automation.invoked": {
      "name": "automation.invoked",
      "description": "Whenever an automation is manually invoked (e.g. by a webhook or API call)."
    }
  },
  "BulkActionStatus": {
    "not_started": {
      "variant": "info",
      "name": "Not started",
      "description": "The bulk action has not yet started."
    },
    "in_progress": {
      "variant": "info",
      "name": "In progress",
      "description": "The bulk action is currently being processed."
    },
    "processed": {
      "variant": "success",
      "name": "Success",
      "description": "The bulk action has completed."
    },
    "failed": {
      "variant": "error",
      "name": "Error",
      "description": "The bulk action was unable to be completed. Buttondown is looking into it."
    }
  },
  "BulkActionType": {
    "apply_tags": {
      "variant": "info",
      "name": "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`)."
    },
    "apply_metadata": {
      "variant": "info",
      "name": "Apply metadata (to subscribers)",
      "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)."
    },
    "ban_subscribers": {
      "variant": "info",
      "name": "Ban subscribers"
    },
    "delete_emails": {
      "variant": "info",
      "name": "Delete emails"
    },
    "delete_comments": {
      "variant": "info",
      "name": "Delete comments"
    },
    "delete_subscribers": {
      "variant": "info",
      "name": "Delete subscribers"
    },
    "delete_tags": {
      "variant": "info",
      "name": "Delete tags"
    },
    "reactivate_subscribers": {
      "variant": "info",
      "name": "Reactivate subscribers"
    },
    "replay_events": {
      "variant": "info",
      "name": "Replay events"
    },
    "resubscribe_subscribers": {
      "variant": "info",
      "name": "Resubscribe subscribers"
    },
    "send_emails": {
      "variant": "info",
      "name": "Send emails",
      "description": "This action requires one additional parameter within `metadata`: `email_id` (the ID of the email which you'd like to send)."
    },
    "send_reminders": {
      "variant": "info",
      "name": "Send reminders"
    },
    "update_email_types": {
      "variant": "info",
      "name": "Update email types"
    },
    "unsubscribe_subscribers": {
      "variant": "info",
      "name": "Unsubscribe subscribers"
    },
    "update_survey_statuses": {
      "variant": "info",
      "name": "Update status types."
    }
  },
  "SubscriberType": {
    "regular": {
      "variant": "success",
      "name": "Regular",
      "description": "Normal subscribers who have not unsubscribed or deactivated in any way."
    },
    "premium": {
      "variant": "success",
      "name": "Premium",
      "description": "Subscribers with active premium subscriptions."
    },
    "trialed": {
      "variant": "info",
      "name": "Trialed",
      "description": "Subscribers that are temporarily receiving a premium subscription to your newsletter."
    },
    "unpaid": {
      "variant": "info",
      "name": "Unpaid",
      "description": "Subscribers who have not yet purchased a subscription to your newsletter."
    },
    "gifted": {
      "variant": "info",
      "name": "Gifted",
      "description": "Subscribers that have been gifted free premium subscriptions."
    },
    "churning": {
      "variant": "warning",
      "name": "Churning",
      "description": "Subscribers who have elected to not renew their subscription to your newsletter and will become unpaid subscribers at the end of their current billing period."
    },
    "unactivated": {
      "variant": "warning",
      "name": "Unactivated",
      "description": "Subscribers who have not yet confirmed their email or opted in."
    },
    "paused": {
      "variant": "warning",
      "name": "Paused",
      "description": "Subscribers that are on a temporary hold from their premium subscription, but are still subscribed to your newsletter."
    },
    "unsubscribed": {
      "variant": "error",
      "name": "Unsubscribed",
      "description": "Subscribers that have or have been unsubscribed from your newsletter."
    },
    "spammy": {
      "variant": "error",
      "name": "Spammy",
      "description": "Subscribers that have been deemed spammy by Buttondown's automated systems."
    },
    "undeliverable": {
      "variant": "error",
      "name": "Undeliverable",
      "description": "Subscribers who have been unable to receive their email."
    },
    "complained": {
      "variant": "error",
      "name": "Complained",
      "description": "Subscribers that have registered a complaint with their email provider. Buttondown will not try to send them any future emails; no action is required on your part."
    },
    "malformed": {
      "variant": "error",
      "name": "Malformed",
      "description": "Subscribers whose email appears to be invalid."
    },
    "removed": {
      "variant": "error",
      "name": "Removed",
      "description": "Subscribers who have been explicitly removed by the newsletter (notably, this does not mean unsubscribers: use /v1/unsubscribers for that!)"
    },
    "disabled": {
      "variant": "error",
      "name": "Disabled",
      "description": "Subscribers who have been disabled by the newsletter."
    },
    "disposable": {
      "variant": "warning",
      "name": "Disposable",
      "description": "Subscribers who have been deemed disposable by Buttondown's automated systems."
    },
    "past_due": {
      "variant": "error",
      "name": "Past due",
      "description": "Subscribers who technically have active paid subscriptions, but have not paid their invoices in time."
    },
    "churned": {
      "variant": "warning",
      "name": "Churned",
      "description": "Subscribers which were previously premium subscribers, but have since churned but are not unsubscribed."
    }
  },
  "AutomationActionType": {
    "add_tags": {
      "variant": "info",
      "name": "Add tags",
      "description": "Add tags to a subscriber."
    },
    "add_metadata": {
      "variant": "info",
      "name": "Apply metadata",
      "description": "Add metadata to a subscriber."
    },
    "remove_tags": {
      "variant": "info",
      "name": "Remove tags",
      "description": "Remove tags from a subscriber."
    },
    "change_email_address": {
      "variant": "info",
      "name": "Change email address",
      "description": "Change the email address of a subscriber."
    },
    "gift_premium_subscription": {
      "variant": "info",
      "name": "Gift premium subscription",
      "description": "Gift a premium subscription to a subscriber."
    },
    "ungift_premium_subscription": {
      "variant": "info",
      "name": "Ungift premium subscription",
      "description": "Remove a gifted premium subscription from a subscriber."
    },
    "send_discord_invitation": {
      "variant": "info",
      "name": "Send Discord invitation",
      "description": "Send a Discord invitation to a subscriber."
    },
    "send_github_invitation": {
      "variant": "info",
      "name": "Send GitHub invitation",
      "description": "Send a GitHub invitation to a subscriber."
    },
    "create_subscriber": {
      "variant": "info",
      "name": "Create subscriber",
      "description": "Create a new subscriber."
    },
    "send_email": {
      "variant": "info",
      "name": "Send email",
      "description": "Send an email to a subscriber."
    },
    "shopify_unsubscribe": {
      "variant": "info",
      "name": "Unsubscribe from Shopify",
      "description": "Unsubscribe a subscriber from your Shopify store."
    },
    "unsubscribe_subscriber": {
      "variant": "info",
      "name": "Unsubscribe from Buttondown",
      "description": "Unsubscribe a subscriber from your newsletter."
    },
    "send_notification": {
      "variant": "info",
      "name": "Send notification",
      "description": "Send a notification to the newsletter author."
    },
    "create_linkedin_post": {
      "variant": "info",
      "name": "Create LinkedIn post",
      "description": "Create a LinkedIn post."
    },
    "create_twitter_post": {
      "variant": "info",
      "name": "Create Twitter post",
      "description": "Create a Twitter post."
    },
    "create_bluesky_post": {
      "variant": "info",
      "name": "Create Bluesky post",
      "description": "Create a Bluesky post."
    },
    "forward_reply": {
      "variant": "info",
      "name": "Forward reply",
      "description": "Forward the reply to a given recipient."
    }
  },
  "NewsletterEmailTemplate": {
    "classic": {
      "variant": "info",
      "name": "Classic",
      "description": "A plaintext template that puts emphasis on your content."
    },
    "modern": {
      "variant": "info",
      "name": "Modern",
      "description": "The default email template."
    },
    "plaintext": {
      "variant": "info",
      "name": "Plaintext",
      "description": "A plaintext (like, literally plaintext, no HTML at all) template for the truly minimalist."
    },
    "naked": {
      "variant": "warning",
      "name": "Naked",
      "description": "The email body itself is used as the template, with no outside scaffolding provided by Buttondown."
    }
  }
}