Reference

Get Account

Retrieve your Kit account details including account ID, subscription plan, email address, and timezone settings to verify your account status and configuration.

Get Account Colors

Retrieve the custom color palette associated with your account to ensure brand consistency across all communications and materials.

Get Creator Profile

Retrieve your creator profile information including name, bio, avatar, and profile URL to use when publishing or customizing content.

Update Account Colors

Customize your Kit account's color palette by updating up to 5 hex color codes that will be applied across broadcasts and email templates. This helps maintain consistent brand identity in all your communications.

Get Broadcast Clicks

Retrieve detailed click data for links shared in a broadcast email or message, helping you understand which content resonates most with your audience.

Get Broadcast Stats

Retrieve performance metrics for a broadcast you've sent, including open rates, click-through rates, and other engagement data to measure campaign effectiveness.

Get Email Stats

Retrieve email performance metrics including send counts, open rates, and click-through data over the last 90 days to understand your email campaign effectiveness.

Get Growth Stats

Retrieve comprehensive growth statistics for your Kit account over a specified date range, with results automatically adjusted to your local timezone. This helps you track key performance metrics and understand how your audience and engagement are changing over time.

Get Subscriber Stats

Retrieve detailed email engagement metrics for a specific subscriber, including opens, clicks, bounces, and conversion rates to understand how your audience is interacting with your campaigns.

Create Broadcast

Create and send email campaigns to your subscribers, with options to draft, schedule for later, or publish immediately to reach your audience.

Delete Broadcast

Remove a broadcast message from your Kit account permanently. Use this when you need to delete a broadcast that was sent in error, is outdated, or is no longer needed.

Get Broadcast

Retrieve detailed information about a specific broadcast message, including its content, status, and performance metrics. Use this when you need to check the details of a broadcast you've already created.

List Broadcasts

Retrieves a list of all your email broadcasts with pagination support, allowing you to review and track all mass communication campaigns you've sent.

Create Custom Field

Add custom data fields to your subscriber profiles to capture information beyond standard contact details, enabling better segmentation and personalization of your communications.

Delete Custom Field

Removes a custom field from your Kit account permanently. Use this when you no longer need to track certain information about your contacts.

List Custom Fields

Retrieve all custom fields you've created in your Kit account to view their names, types, and configuration details. This helps you understand what subscriber data fields are available for segmentation and personalization.

Update Custom Field

Modify the label or name of a custom field in your Kit account to better reflect your business needs or organizational changes. This helps keep your customer data structure organized and aligned with your current terminology.

Add Subscriber to Form

Associates an existing subscriber with a specific form in Kit, allowing you to organize and track which contacts have engaged with particular signup forms or campaigns.

Add Subscriber to Form by Email

Assign an existing subscriber to a specific form using their email address, allowing you to organize your contacts into targeted groups or campaigns.

List Forms

Retrieve all forms from your Kit account with filtering options by status and type, along with pagination support to manage large form collections.

List Subscribers For Form

Retrieve a list of subscribers who joined a specific form, with options to filter by date, status, and pagination to manage large subscriber lists.

List Segments

Retrieve your email subscriber segments to view all audience groups you've created for targeted messaging campaigns.

List Sequences

Retrieve all your email sequences with pagination support to view and manage your automated messaging campaigns.

Create Subscriber

Add a new email subscriber to your mailing list or update an existing subscriber's information. This helps you grow your audience and keep contact details current for your email campaigns.

Filter Subscribers

Segment your email subscribers based on their engagement behavior like opens, clicks, and delivery status to identify your most active or inactive audience members. This helps you target the right people with the right message at the right time.

List Subscribers

Retrieve your email subscriber list with options to filter, sort, and paginate through results. Use this to access and analyze your growing audience data whenever you need subscriber information.

Update Subscriber

Update a subscriber's details such as name, email address, or custom fields to keep your contact information current and accurate.

Delete Subscriber

Permanently removes a subscriber from your email communications, deleting them from all sequences and campaigns while preserving their historical data. Use this when customers unsubscribe, request removal, or need to be taken off your mailing list.

Get Subscriber

Retrieve detailed information about a specific subscriber using their ID, such as email, contact details, and subscription status. This helps you verify subscriber information and access their profile data quickly.

Tag Subscriber by Email

Assign organizational tags to your existing email subscribers to categorize and segment your audience for targeted communication. This helps you organize contacts based on their interests, behavior, or status within your Kit account.

Create Tag

Create custom tags to organize and segment your subscribers, making it easier to target specific groups with personalized communication.

Delete Tag

Remove a tag from your Kit workspace when it's no longer needed or has become outdated. Helps keep your communication system organized by eliminating unused or duplicate tags.

List Tag Subscribers

Retrieves all subscribers associated with a specific tag in your email list, helping you identify and manage segmented groups of contacts based on their interests or characteristics.

List Tags

Retrieve all tags in your Kit account to view and organize your contact segmentation and categorization system. This helps you understand how your audience is currently tagged and segmented.

Remove Tag From Subscriber

Remove a tag from a subscriber in your Kit mailing list, allowing you to update subscriber segments and organize your audience more effectively. This helps keep your contact organization current as subscriber interests and engagement levels change.

Tag Subscriber

Organize and categorize your email subscribers by assigning them relevant tags, making it easier to segment your audience for targeted campaigns and personalized communication.

Untag Subscriber by Email

Remove a tag from a subscriber by their email address, allowing you to update how contacts are organized and segmented in your email list.

Update Tag

Update an existing tag's name to keep your communication organization current and relevant. This helps maintain clean, organized contact categorization as your business needs evolve.

List Email Templates

Retrieve all your email templates from Kit to view available designs and messaging options for your campaigns. This helps you understand what template resources you have available before sending emails.

Create Webhook

Set up automatic notifications to your application when subscriber activities or purchases happen in your Kit account, enabling real-time updates without constant manual checking.

Delete Webhook

Permanently removes a webhook from your Kit account so it stops receiving event notifications. Use this when you no longer need automated updates sent to a particular endpoint.

List Webhooks

View all webhooks configured in your Kit account, including their event types and target URLs, to understand which integrations are actively sending you data.