kit · 42 tools · no triggers
Connect it
run auth kit
run auth kit --scope team # shared with the organization
Use it
run kit # common commands
run kit --all # every command
import { kit } from "@boxd/run";
Common tools
| Tool | What it does |
|---|---|
add-subscriber-to-form | Add an existing subscriber to a form by their IDs. This action associates a subscriber with a form in Kit. |
add-subscriber-to-form-by-email | Tool to add an existing subscriber to a form using their email address. |
create-broadcast | Tool to create a new broadcast (email campaign) to send to subscribers. |
create-custom-field | Tool to create a new custom field for subscriber data. Use when you need to store extra attributes for subscribers. |
create-subscriber | Tool to create a new subscriber or update an existing one (upsert). |
create-tag | Tool to create a new tag in the account. Use when you need a custom label to segment subscribers. |
create-webhook | Creates a webhook subscription for real-time event notifications. |
delete-broadcast | Tool to delete a specific broadcast. Use when you need to permanently remove a broadcast by ID (after confirming the ID). |
delete-custom-field | Tool to delete a specific custom field. Use after confirming the custom field ID is correct. |
delete-subscriber | Unsubscribe a subscriber from all email communications by their ID. |
delete-tag | Tool to delete a tag by ID. Use when you need to remove obsolete or incorrect tags after confirming the tag exists. |
delete-webhook | Tool to delete a webhook by ID. Use when you want to permanently remove a webhook after confirming its ID. |
filter-subscribers | Tool to filter subscribers based on engagement criteria such as email opens, clicks, or delivery status. |
get-account | Tool to retrieve current account information. Use after validating API key to fetch account ID, plan type, primary email, and timezone details. |
get-account-colors | Tool to retrieve list of colors associated with the account. |
get-broadcast | Tool to retrieve details of a specific broadcast by ID. Use when you have a valid broadcast ID and need its metadata. |
get-broadcast-clicks | Tool to retrieve link click data for a specific broadcast by ID. |
get-broadcast-stats | Tool to retrieve statistics for a specific broadcast by ID. Use after a broadcast has been sent to monitor performance. |
get-creator-profile | Tool to retrieve the creator profile information for the account. |
get-email-stats | Tool to retrieve email statistics for the account. Use after confirming authentication to fetch metrics on emails (sent, opened, clicked) over the last 90 days. |
get-growth-stats | Tool to retrieve growth statistics for the account over a date range. |
get-subscriber | Tool to retrieve a specific subscriber by their ID. Use when you need to fetch detailed information about a single subscriber. |
get-subscriber-stats | Tool to retrieve email stats for a specific subscriber. Use when you need subscriber engagement metrics (opens, clicks, bounces, rates). |
list-broadcasts | Tool to retrieve a paginated list of all broadcasts. Use when you need to enumerate or review broadcast summaries with cursor-based pagination. |
list-custom-fields | Tool to retrieve a paginated list of custom fields. Use after confirming you need to enumerate or inspect all custom fields with cursor-based pagination. |
All 42 tools
All 42 tools
| Tool | What it does |
|---|---|
add-subscriber-to-form | Add an existing subscriber to a form by their IDs. This action associates a subscriber with a form in Kit. |
add-subscriber-to-form-by-email | Tool to add an existing subscriber to a form using their email address. |
create-broadcast | Tool to create a new broadcast (email campaign) to send to subscribers. |
create-custom-field | Tool to create a new custom field for subscriber data. Use when you need to store extra attributes for subscribers. |
create-subscriber | Tool to create a new subscriber or update an existing one (upsert). |
create-tag | Tool to create a new tag in the account. Use when you need a custom label to segment subscribers. |
create-webhook | Creates a webhook subscription for real-time event notifications. |
delete-broadcast | Tool to delete a specific broadcast. Use when you need to permanently remove a broadcast by ID (after confirming the ID). |
delete-custom-field | Tool to delete a specific custom field. Use after confirming the custom field ID is correct. |
delete-subscriber | Unsubscribe a subscriber from all email communications by their ID. |
delete-tag | Tool to delete a tag by ID. Use when you need to remove obsolete or incorrect tags after confirming the tag exists. |
delete-webhook | Tool to delete a webhook by ID. Use when you want to permanently remove a webhook after confirming its ID. |
filter-subscribers | Tool to filter subscribers based on engagement criteria such as email opens, clicks, or delivery status. |
get-account | Tool to retrieve current account information. Use after validating API key to fetch account ID, plan type, primary email, and timezone details. |
get-account-colors | Tool to retrieve list of colors associated with the account. |
get-broadcast | Tool to retrieve details of a specific broadcast by ID. Use when you have a valid broadcast ID and need its metadata. |
get-broadcast-clicks | Tool to retrieve link click data for a specific broadcast by ID. |
get-broadcast-stats | Tool to retrieve statistics for a specific broadcast by ID. Use after a broadcast has been sent to monitor performance. |
get-creator-profile | Tool to retrieve the creator profile information for the account. |
get-email-stats | Tool to retrieve email statistics for the account. Use after confirming authentication to fetch metrics on emails (sent, opened, clicked) over the last 90 days. |
get-growth-stats | Tool to retrieve growth statistics for the account over a date range. |
get-subscriber | Tool to retrieve a specific subscriber by their ID. Use when you need to fetch detailed information about a single subscriber. |
get-subscriber-stats | Tool to retrieve email stats for a specific subscriber. Use when you need subscriber engagement metrics (opens, clicks, bounces, rates). |
list-broadcasts | Tool to retrieve a paginated list of all broadcasts. Use when you need to enumerate or review broadcast summaries with cursor-based pagination. |
list-custom-fields | Tool to retrieve a paginated list of custom fields. Use after confirming you need to enumerate or inspect all custom fields with cursor-based pagination. |
list-email-templates | Retrieve a paginated list of all email templates in the Kit account. |
list-forms | Lists all forms in your Kit account with optional filtering and cursor-based pagination. |
list-segments | Tool to retrieve a paginated list of segments. Use when you need to enumerate segments with cursor-based pagination for further processing or display. |
list-sequences | Tool to retrieve a paginated list of all sequences. Use when you need to enumerate sequences with pagination for further processing or display. |
list-subscribers | Tool to retrieve a list of subscribers. Use when you need to fetch subscriber records with optional filtering, sorting, and pagination. |
list-subscribers-for-form | Retrieves subscribers for a specific form by ID with optional filtering and cursor-based pagination. |
list-tags | Retrieve a paginated list of all tags in the Kit account. Returns tag details including ID, name, and creation date. |
list-tag-subscribers | Tool to retrieve subscribers for a specific tag. Use after confirming the tag ID when you need to list subscribers associated with a tag. |
list-webhooks | Retrieve a paginated list of all webhooks configured in the Kit account. |
remove-tag-from-subscriber | Tool to remove a tag from a subscriber using their subscriber ID. |
tag-subscriber | Tool to associate a subscriber with a specific tag by ID. Use after confirming tag and subscriber IDs when tagging a subscriber. |
tag-subscriber-by-email | Assigns a tag to an existing subscriber using their email address. |
untag-subscriber-by-email | Tool to remove a tag from a subscriber using their email address. |
update-account-colors | Tool to update the list of colors for the account. Use when customizing your Kit account’s color palette for broadcasts and templates. |
update-custom-field | Tool to update a custom field’s label. Use after listing or retrieving custom fields and confirming the field ID to rename. |
update-subscriber | Tool to update an existing subscriber’s information. Use when you need to modify a subscriber’s first name, email address, or custom fields. |
update-tag | Tool to update a tag’s name by ID. Use after retrieving tag ID and confirming the new name. |