Skip to main content
Kit logo
  • Category: marketing automation
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? Yes
  • Tools: 42
  • Triggers: 17
  • Slug: KIT
  • Version: 20261101_00

Tools

Slug: KIT_ADD_SUBSCRIBER_TO_FORMAdd an existing subscriber to a form by their IDs. An optional referrer URL can be provided for tracking; the response includes the subscriber’s form details and referrer parameters.

Input Parameters

integer
required
The ID of the subscriber to add to the form. Use KIT_LIST_SUBSCRIBERS to get valid subscriber IDs. The subscriber must already exist in your Kit account.
integer
required
The ID of the form to which the subscriber will be added. Use KIT_LIST_FORMS to get valid form IDs.
string
Optional referrer URL for tracking purposes. Can include UTM parameters (e.g., utm_source, utm_medium, utm_campaign) which will be parsed and included in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_ADD_SUBSCRIBER_TO_FORM_BY_EMAILAdd an existing subscriber to a form using their email address. Returns the subscriber’s form details.

Input Parameters

integer
required
The ID of the form to which the subscriber will be added. Use KIT_LIST_FORMS to get valid form IDs.
string
Optional referrer URL for tracking purposes. Can include UTM parameters (e.g., utm_source, utm_medium, utm_campaign) which will be parsed and included in the response.
string
required
The email address of the subscriber to add to the form. The subscriber must already exist in your Kit account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_ADD_SUBSCRIBER_TO_SEQUENCEEnroll an existing Kit subscriber in an active email sequence.

Input Parameters

integer
required
Unique identifier of the active sequence. Use KIT_LIST_SEQUENCES to find sequence IDs.
string
required
Email address of an existing Kit subscriber to enroll in the sequence.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_BULK_REMOVE_TAGS_FROM_SUBSCRIBERSRemove multiple Kit tag-subscriber associations. Requires OAuth 2.0; API keys are not supported.

Input Parameters

array
required
Non-empty list of tag-subscriber associations to remove.
string
URL Kit should notify when an asynchronously processed request finishes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_CREATE_BROADCASTCreate a Kit email broadcast for subscribers with a subject and content. Save it as a draft or schedule it for a future time, and optionally publish it to your public creator profile. Subscriber filters can target specific audiences.

Input Parameters

boolean
Whether to publish the broadcast to your public creator profile. Set to true to make it visible on your website.
string
required
Email content/body (HTML or plain text)
string
Scheduled send time in ISO 8601 format. Set to null to save as draft without scheduling. Must be a future timestamp.
string
required
Email subject line for the broadcast
string
Internal description for the broadcast (not visible to subscribers)
string
Sending email address to use for the broadcast. Uses the account’s default sending email address if not provided. Must be a confirmed email address associated with your account.
integer
ID of the email template to use for styling. If not provided, the default template will be used.
array
Array of filter groups to target specific subscribers. Each group contains conditions combined with ‘all’ logic. If not provided, sends to all subscribers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_CREATE_CUSTOM_FIELDTool to create a new custom field for subscriber data. Use when you need to store extra attributes for subscribers.

Input Parameters

string
required
The display label for the custom field (e.g., ‘Favorite Color’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_CREATE_SUBSCRIBERTool to create a new subscriber or update an existing one (upsert). If a subscriber with the provided email address does not exist, creates one. If already exists, updates the first name.

Input Parameters

string ("active" | "inactive" | "bounced" | "complained" | "cancelled")
Valid states for a subscriber.
object
Custom fields as key-value pairs. Custom fields that don’t exist will be ignored by the API.
string
The subscriber’s first name. If the subscriber already exists, this will update their first name.
string
required
The subscriber’s email address (required). If a subscriber with this email already exists, their first name will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_CREATE_TAGTool to create a new tag in the account. Use when you need a custom label to segment subscribers. Use after confirming tag uniqueness to avoid duplicates. Example: “Create a tag called ‘VIP’ for premium customers.”

Input Parameters

string
required
Name of the tag to be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_CREATE_WEBHOOKCreates a webhook subscription for real-time event notifications. Use this to receive HTTP POST notifications when subscriber events (activate, unsubscribe, form subscribe, tag add/remove, link clicks, etc.) or purchase events occur in your Kit account.

Input Parameters

object
required
Event type and optional filters for the webhook subscription.
string
required
HTTPS URL endpoint that will receive webhook POST notifications when the event triggers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_DELETE_BROADCASTTool to delete a specific broadcast. Use when you need to permanently remove a broadcast by ID (after confirming the ID). Example prompt: “Delete broadcast with ID 123”

Input Parameters

integer
required
Unique identifier of the broadcast to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_DELETE_CUSTOM_FIELDTool to delete a specific custom field. Use after confirming the custom field ID is correct. Deletes the field permanently.

Input Parameters

integer
required
Unique identifier of the custom field to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_DELETE_SUBSCRIBERUnsubscribe a subscriber from all email communications by their ID. This action permanently unsubscribes a subscriber, removing them from all sequences and forms. The subscriber’s historical data is retained but they will no longer receive emails. This operation is idempotent - unsubscribing an already-unsubscribed subscriber succeeds without error. Use KIT_LIST_SUBSCRIBERS to find valid subscriber IDs before calling this action. Returns: Empty response on success (HTTP 204 No Content). Raises: ExecutionFailed: If the subscriber ID doesn’t exist (404), authentication fails (401), or other API errors occur.

Input Parameters

integer
required
The unique subscriber ID to unsubscribe. Must be a positive integer. Use KIT_LIST_SUBSCRIBERS to find valid subscriber IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_DELETE_TAGTool to delete a tag by ID. Use when you need to remove obsolete or incorrect tags after confirming the tag exists.

Input Parameters

integer
required
Unique identifier of the tag to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_DELETE_WEBHOOKTool to delete a webhook by ID. Use when you want to permanently remove a webhook after confirming its ID.

Input Parameters

integer
required
Unique identifier of the webhook to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_FILTER_SUBSCRIBERSTool to filter subscribers based on engagement criteria such as email opens, clicks, or delivery status. Use when you need to segment subscribers by their engagement behavior with specific date ranges and count thresholds.

Input Parameters

array
required
Array of filter conditions where ALL must be met (AND logic). At least one condition is required. Each condition filters subscribers based on engagement type (opens, clicks, sent, delivered, subscribed) with optional count and date constraints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_GET_ACCOUNTTool to retrieve current account information. Use after validating API key to fetch account ID, plan type, primary email, and timezone details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_GET_ACCOUNT_COLORSTool to retrieve list of colors associated with the account. Use after confirming authentication to fetch account-specific color palette.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_GET_BROADCASTTool to retrieve details of a specific broadcast by ID. Use when you have a valid broadcast ID and need its metadata.

Input Parameters

integer
required
Unique identifier of the broadcast to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_GET_BROADCAST_CLICKSTool to retrieve link click data for a specific broadcast by ID. Use when you need to analyze which links were clicked and their engagement metrics.

Input Parameters

string
Pagination cursor to retrieve results after this cursor
string
Pagination cursor to retrieve results before this cursor
integer
Number of results per page; must be between 1 and 500
integer
required
Unique identifier of the broadcast to fetch click data for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_GET_BROADCAST_STATSTool to retrieve statistics for a specific broadcast by ID. Use after a broadcast has been sent to monitor performance.

Input Parameters

integer
required
Unique identifier of the broadcast to fetch statistics for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_GET_CREATOR_PROFILETool to retrieve the creator profile information for the account. Use when you need creator metadata (name, bio, avatar, profile URL) before publishing or customizing content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_GET_EMAIL_STATSTool to retrieve email statistics for the account. Use after confirming authentication to fetch metrics on emails (sent, opened, clicked) over the last 90 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_GET_GROWTH_STATSTool to retrieve growth statistics for the account over a date range. Stats are returned in your sending time zone (not UTC). Defaults to last 90 days if no dates specified.

Input Parameters

string
Get stats for time period ending on this date (format yyyy-mm-dd). Defaults to today.
string
Get stats for time period beginning on this date (format yyyy-mm-dd). Defaults to 90 days ago.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_GET_SEQUENCE_EMAILRetrieve one sequence email with its full content and delivery settings.

Input Parameters

string
Set to ‘stats’ to include delivery and engagement statistics.
integer
required
Unique identifier of the sequence email to retrieve.
integer
required
Unique identifier of the sequence containing the email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_GET_SUBSCRIBERTool to retrieve a specific subscriber by their ID. Use when you need to fetch detailed information about a single subscriber.

Input Parameters

integer
required
The unique subscriber ID to retrieve. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_GET_SUBSCRIBER_STATSTool to retrieve email stats for a specific subscriber. Use when you need subscriber engagement metrics (opens, clicks, bounces, rates). Data only available for events from June 2025 onwards.

Input Parameters

integer
required
The ID of the subscriber to get stats for
string
Filter to stats for emails sent after this date (YYYY-MM-DD format). Must be on or after 2025-06-24.
string
Filter to stats for emails sent before this date (YYYY-MM-DD format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_BROADCASTSTool to retrieve a paginated list of all broadcasts. Use when you need to enumerate or review broadcast summaries with cursor-based pagination.

Input Parameters

string
Cursor for pagination; returns results after the specified cursor.
string
Cursor for pagination; returns results before the specified cursor.
integer
Number of results per page; must be between 1 and 500.
string
If set to ‘true’, includes the total count of records in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_CUSTOM_FIELDSTool to retrieve a paginated list of custom fields. Use after confirming you need to enumerate or inspect all custom fields with cursor-based pagination.

Input Parameters

string
Cursor for pagination; returns results after the specified cursor.
string
Cursor for pagination; returns results before the specified cursor.
integer
Number of results per page; defaults to 500 if not specified.
string
If set to ‘true’, includes the total count of records in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_EMAIL_TEMPLATESRetrieve a paginated list of all email templates in the Kit account. Returns template details including ID, name, default status, and category. Supports cursor-based pagination for navigating large template collections. Use this when you need to view or iterate through email templates.

Input Parameters

string
Cursor for fetching the next page of results. Use the ‘end_cursor’ value from a previous response.
string
Cursor for fetching the previous page of results. Use the ‘start_cursor’ value from a previous response.
integer
Number of email templates to return per page. Default is 500, maximum is 1000.
boolean
Include the total count of email templates in the response. Note: This may slow down the response for large collections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_FORMSLists all forms in your Kit account with optional filtering and cursor-based pagination. Use this to retrieve forms when you need to: - Get all available forms (landing pages and embedded forms) - Filter by status (active, archived, trashed) or type (embed, hosted) - Paginate through large collections of forms - Get form IDs and metadata for other operations

Input Parameters

string ("embed" | "hosted")
Filter forms by type.
string
Cursor for pagination; returns results after the specified cursor.
string
Cursor for pagination; returns results before the specified cursor.
string ("active" | "archived" | "trashed" | "all")
Filter forms by status: ‘active’ (default), ‘archived’, ‘trashed’, or ‘all’.
integer
Number of forms to return per page (default: 500, max: 1000).
boolean
If set to true, includes the total count of forms in the response (may be slower for large collections).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_SEGMENTSTool to retrieve a paginated list of segments. Use when you need to enumerate segments with cursor-based pagination for further processing or display.

Input Parameters

string
Cursor for pagination; returns results after this cursor.
string
Cursor for pagination; returns results before this cursor.
integer
Number of segments to return per page (min 1).
string ("true" | "false")
If set to ‘true’, includes the total count of segments in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_SEQUENCE_EMAILSList emails in a sequence with optional content, stats, and pagination.

Input Parameters

string
Return the page after this end cursor.
string
Return the page before this start cursor.
string
Set to ‘stats’ to include per-email deliverability statistics.
integer
Number of emails to return per page (default 500, maximum 1000).
integer
required
Unique identifier of the sequence whose emails to list.
boolean
Include the potentially large HTML content field for each email.
boolean
Include total_count in pagination. This can make the request slower.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_SEQUENCESTool to retrieve a paginated list of all sequences. Use when you need to enumerate sequences with pagination for further processing or display.

Input Parameters

string
Cursor for pagination; returns results after the specified cursor.
string
Cursor for pagination; returns results before the specified cursor.
integer
Number of results per page (max 1000, default 500).
string ("true" | "false")
If set to ‘true’, includes the total count in the pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_SEQUENCE_SUBSCRIBERSList subscribers enrolled in a sequence with filters and cursor pagination.

Input Parameters

string
Return the page after this end cursor.
string
Return the page before this start cursor.
string ("active" | "inactive" | "bounced" | "complained" | "cancelled" | "all")
Subscriber status to return. Defaults to active; use all for every status.
integer
Number of subscribers to return per page (default 500, maximum 1000).
string
Return subscribers added to the sequence after this ISO 8601 date/time.
integer
required
Unique identifier of the sequence whose subscribers to list.
string
Return subscribers added to the sequence before this ISO 8601 date/time.
string
Return subscribers created after this ISO 8601 date/time.
string
Return subscribers created before this ISO 8601 date/time.
boolean
Include total_count in pagination. This can make the request slower.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_SUBSCRIBERSTool to retrieve a list of subscribers. Use when you need to fetch subscriber records with optional filtering, sorting, and pagination.

Input Parameters

string
Cursor for pagination; returns subscribers after this cursor.
string
Cursor for pagination; returns subscribers before this cursor.
string
Filter by subscriber status (e.g., ‘active’ or ‘inactive’).
integer
Number of subscribers to return per page (min 1).
string ("id" | "cancelled_at" | "updated_at")
Field by which to sort the subscribers. Must be one of: ‘id’, ‘cancelled_at’, or ‘updated_at’. Note: If ‘cancelled_at’ is used, the status parameter must be set to ‘cancelled’.
string ("asc" | "desc")
Order in which to sort the results.
string
Filter to subscribers created after this date (YYYY-MM-DD).
string
Exact email address to filter by.
string
Filter to subscribers updated after this date (YYYY-MM-DD).
string
Filter to subscribers created before this date (YYYY-MM-DD).
string
Filter to subscribers updated before this date (YYYY-MM-DD).
string ("true" | "false")
If set to ‘true’, includes the total count of subscribers in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_SUBSCRIBERS_FOR_FORMRetrieves subscribers for a specific form by ID with optional filtering and cursor-based pagination. Use this action to: - Get all subscribers who have joined a specific form - Filter subscribers by when they were added to the form (added_after/added_before) - Filter subscribers by when they were created (created_after/created_before) - Filter by subscriber status (e.g., ‘active’) - Navigate through results using cursor-based pagination (after/before cursors) - Control page size with per_page parameter - Optionally get total subscriber count with include_total_count=‘true’ First use KIT_LIST_FORMS to get valid form_id values.

Input Parameters

string
Cursor for pagination; returns results after this cursor.
string
Cursor for pagination; returns results before this cursor.
string
Filter subscribers by status (e.g., ‘active’).
integer
required
ID of the form whose subscribers you want to retrieve.
integer
Number of results to return per page (min 1).
string
Return subscribers added to the form after this date/time (ISO 8601).
string
Return subscribers added to the form before this date/time (ISO 8601).
string
Return subscribers created after this date/time (ISO 8601).
string
Return subscribers created before this date/time (ISO 8601).
string ("true" | "false")
If ‘true’, includes the total count of subscribers in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_SUBSCRIBER_TAGSList tags currently applied to a Kit subscriber.

Input Parameters

string
Cursor for fetching the next page. Use the previous response’s end_cursor.
string
Cursor for fetching the previous page. Use the previous response’s start_cursor.
integer
Number of tags to return per page. The provider default is 500 and maximum is 1000.
integer
required
Unique identifier of the subscriber whose tags should be listed.
boolean
Whether to include the total number of tags in the pagination object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_TAGSRetrieve a paginated list of all tags in the Kit account. Returns tag details including ID, name, and creation date. Supports cursor-based pagination for navigating large tag collections. Use this when you need to view or iterate through tags.

Input Parameters

string
Cursor for fetching the next page of results. Use the ‘end_cursor’ value from a previous response.
string
Cursor for fetching the previous page of results. Use the ‘start_cursor’ value from a previous response.
integer
Number of tags to return per page. Default is 500, maximum is 1000.
boolean
Include the total count of tags in the response. Note: This may slow down the response for large collections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_TAG_SUBSCRIBERSTool to retrieve subscribers for a specific tag. Use after confirming the tag ID when you need to list subscribers associated with a tag.

Input Parameters

string
Cursor for pagination; returns subscribers after this cursor.
string
Cursor for pagination; returns subscribers before this cursor.
string
Filter by subscriber status (‘active’ or ‘inactive’).
integer
required
Unique identifier of the tag to retrieve subscribers for
integer
Number of subscribers to return per page (min 1).
string
Filter to subscribers tagged after this timestamp (ISO 8601).
string
Filter to subscribers created after this timestamp (ISO 8601).
string
Filter to subscribers tagged before this timestamp (ISO 8601).
string
Filter to subscribers created before this timestamp (ISO 8601).
string ("true" | "false")
If set to ‘true’, includes total count of subscribers in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_LIST_WEBHOOKSRetrieve a paginated list of all webhooks configured in the Kit account. Returns webhook details including ID, event type, and target URL. Supports cursor-based pagination for navigating large webhook collections. Use this when you need to view or iterate through webhooks.

Input Parameters

string
Cursor for fetching the next page of results. Use the ‘end_cursor’ value from a previous response.
string
Cursor for fetching the previous page of results. Use the ‘start_cursor’ value from a previous response.
integer
Number of webhooks to return per page. Default is 500, maximum is 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_REMOVE_TAG_FROM_SUBSCRIBERTool to remove a tag from a subscriber using their subscriber ID. Use when you need to untag a subscriber from a specific tag after confirming both tag and subscriber IDs exist.

Input Parameters

integer
required
The unique ID of the tag to remove from the subscriber
integer
required
The unique ID of the subscriber to remove the tag from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_TAG_SUBSCRIBERTool to associate a subscriber with a specific tag by ID. Use after confirming tag and subscriber IDs when tagging a subscriber.

Input Parameters

integer
required
ID of the tag to assign
integer
required
ID of the subscriber to tag

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_TAG_SUBSCRIBER_BY_EMAILAssigns a tag to an existing subscriber using their email address. The subscriber must already exist in your Kit account. Returns the subscriber’s details including the timestamp when they were tagged. Use when you have a valid tag ID and the subscriber’s email address.

Input Parameters

integer
required
The ID of the tag to assign to the subscriber
string
required
The subscriber’s email address. The subscriber must already exist in your Kit account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_UNTAG_SUBSCRIBER_BY_EMAILTool to remove a tag from a subscriber using their email address. Use when you need to untag an existing subscriber after confirming both the tag ID and subscriber’s email address are valid.

Input Parameters

integer
required
The ID of the tag to remove from the subscriber
string
required
The email address of the subscriber to untag. The subscriber must already exist in your Kit account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_UPDATE_ACCOUNT_COLORSTool to update the list of colors for the account. Use when customizing your Kit account’s color palette for broadcasts and templates. Maximum 5 hex color codes allowed per account.

Input Parameters

array
required
List of hex color codes to set for the account (e.g., ‘#008000’, ‘#FF0000’). Maximum 5 colors allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_UPDATE_CUSTOM_FIELDTool to update a custom field’s label. Use after listing or retrieving custom fields and confirming the field ID to rename.

Input Parameters

integer
required
Unique identifier of the custom field to update
string
required
New label for the custom field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_UPDATE_SEQUENCE_EMAILPartially update a Kit sequence email. Publishing the first email or changing position can immediately send, skip, or reorder delivery for active subscribers.

Input Parameters

string
New HTML body. Pass null to clear it
string
New subject line for the email
integer
required
Unique identifier of the email
integer
Zero-based sequence position. Pass null to clear it
boolean
Whether the sequence email is published
array
Allowed delivery days. Pass null to inherit the sequence schedule
string ("days" | "hours")
Unit for the delivery delay
integer
New nonnegative delivery delay
integer
required
Unique identifier of the sequence containing the email
string
New inbox preview text. Pass null to clear it
integer
Email template ID. Pass null to clear the template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_UPDATE_SUBSCRIBERTool to update an existing subscriber’s information. Use when you need to modify a subscriber’s first name, email address, or custom fields. Supports updating up to 140 custom fields at a time.

Input Parameters

integer
required
The unique subscriber ID to update. Must be a positive integer. Use KIT_LIST_SUBSCRIBERS to find valid subscriber IDs.
object
Custom fields as key-value pairs. Maximum 140 custom fields can be updated at a time. The API will ignore custom fields that don’t exist in your account.
string
The subscriber’s first name to update.
string
The subscriber’s email address to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIT_UPDATE_TAGTool to update a tag’s name by ID. Use after retrieving tag ID and confirming the new name.

Input Parameters

integer
required
Unique identifier of the tag to update
string
required
New name for the tag

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: KIT_BROADCAST_CREATEDType: webhookTriggers when a broadcast is created, including one saved as a draft. Kit emits this before it enforces the confirmed-send-address check, so a create the API reported as failed still fires it.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_BROADCAST_DELETEDType: webhookTriggers when a broadcast is deleted.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_CUSTOM_FIELD_CREATEDType: webhookTriggers when a custom field is defined on the account.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_CUSTOM_FIELD_DELETEDType: webhookTriggers when a custom field is deleted from the account.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_SEQUENCE_CREATEDType: webhookTriggers when an email sequence is created. Kit creates sequences already active, so KIT_SEQUENCE_PUBLISHED does not also fire.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_SEQUENCE_DELETEDType: webhookTriggers when an email sequence is deleted.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_SEQUENCE_DISABLEDType: webhookTriggers when a published email sequence is disabled. Only a real active-to-disabled transition fires it — disabling a sequence that is already disabled emits nothing.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_SEQUENCE_PUBLISHEDType: webhookTriggers when a disabled email sequence is published. Only a real disabled-to-active transition fires it — publishing a sequence that is already active emits nothing.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_SUBSCRIBER_ACTIVATEDType: webhookTriggers when a subscriber becomes active — a double opt-in signup is confirmed, a past subscriber re-subscribes, or a new subscriber is created active. Use KIT_SUBSCRIBER_CREATED for the moment the record first appears instead.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_SUBSCRIBER_ADDED_TO_SEQUENCEType: webhookTriggers when a subscriber is added to an email sequence. Set sequence_id to watch a single sequence.

Configuration

integer
Only fire for this sequence. Leave unset to fire for every sequence. Use KIT_LIST_SEQUENCES to find sequence ids.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_SUBSCRIBER_CREATEDType: webhookTriggers when a subscriber record is created on the account. A subscriber created through Kit’s API is also activated in the same moment, so it fires KIT_SUBSCRIBER_ACTIVATED as a second, separate event.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_SUBSCRIBER_CUSTOM_FIELD_VALUE_UPDATEDType: webhookTriggers when a subscriber’s custom field value changes, including the first time it is set. Kit sends one event per field changed. Set custom_field_key to watch a single field.

Configuration

string
Only fire when this custom field changes, addressed by its key (e.g. ‘lifecycle_stage’). Leave unset to fire for every field. Use KIT_LIST_CUSTOM_FIELDS to see the keys defined on the account.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_SUBSCRIBER_TAG_ADDEDType: webhookTriggers when a tag is added to a subscriber. Set tag_id to watch a single tag.

Configuration

integer
Only fire for this tag. Leave unset to fire for every tag. Use KIT_LIST_TAGS to find tag ids.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_SUBSCRIBER_TAG_REMOVEDType: webhookTriggers when a tag is removed from an individual subscriber. Deleting the tag itself fires KIT_TAG_DELETED once instead of this event per subscriber. Set tag_id to watch a single tag.

Configuration

integer
Only fire for this tag. Leave unset to fire for every tag. Use KIT_LIST_TAGS to find tag ids.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_SUBSCRIBER_UNSUBSCRIBEDType: webhookTriggers when a subscriber unsubscribes from the account’s emails. The subscriber arrives with state set to ‘cancelled’.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_TAG_CREATEDType: webhookTriggers when a tag is created on the account.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).
Slug: KIT_TAG_DELETEDType: webhookTriggers when a tag is deleted from the account. This is the only event the deletion produces, so a workflow mirroring tag membership must drop the tag from every subscriber here — KIT_SUBSCRIBER_TAG_REMOVED does not fire per subscriber.

Payload

string
required
RFC3339 timestamp of the underlying change (not the delivery time).
object
required
The Kit resources the event is about.
string
required
The Kit event type that fired (e.g. ‘subscriber.tag_added’).