Kit

Learn how to use Kit with Composio

Overview

Enum

KIT

Description

Template description for kit

Authentication Details

api_key
stringRequired

Actions

Tool to add a subscriber to a specific form by id. use after confirming form and subscriber ids.

Action Parameters

form_id
integerRequired
id
integerRequired
referrer
string

Action Response

data
object
error
string
successful
boolean
Tool to create a new custom field for subscriber data. use when you need to store extra attributes for subscribers.

Action Parameters

label
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool 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."

Action Parameters

name
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to create a new webhook subscription. use when you need subscriber or purchase event notifications.

Action Parameters

event
objectRequired
target_url
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool 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"

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a specific custom field. use after confirming the custom field id is correct. deletes the field permanently.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete (unsubscribe) a subscriber by id. use when you need to remove a subscriber from all sequences and forms after confirming the subscriber exists.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a tag by id. use when you need to remove obsolete or incorrect tags after confirming the tag exists.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a webhook by id. use when you want to permanently remove a webhook after confirming its id.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve current account information. use after validating api key to fetch account id, plan type, primary email, and timezone details.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to retrieve list of colors associated with the account. use after confirming authentication to fetch account-specific color palette.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to retrieve details of a specific broadcast by id. use when you have a valid broadcast id and need its metadata.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve statistics for a specific broadcast by id. use after a broadcast has been sent to monitor performance.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve the creator profile information for the account. use when you need creator metadata (bio, avatar, social links) before publishing or customizing content.

Action Parameters

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to retrieve a paginated list of all broadcasts. use when you need to enumerate or review broadcast summaries with cursor-based pagination.

Action Parameters

after
string
before
string
include_total_count
string
per_page
integer

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

after
string
before
string
include_total_count
string
per_page
integer

Action Response

data
object
error
string
successful
boolean
Tool to list all forms. use when you need to fetch forms with optional filters and pagination.

Action Parameters

after
string
before
string
include_total_count
string
per_page
integer
status
string
type
string

Action Response

data
object
error
string
successful
boolean
Tool to retrieve a paginated list of segments. use when you need to enumerate segments with cursor-based pagination for further processing or display.

Action Parameters

after
string
before
string
include_total_count
string
per_page
integer

Action Response

data
object
error
string
successful
boolean
Tool to retrieve a paginated list of all sequences. use when you need to enumerate sequences with pagination for further processing or display.

Action Parameters

after
string
before
string
include_total_count
string
per_page
integer

Action Response

data
object
error
string
successful
boolean
Tool to retrieve a list of subscribers. use when you need to fetch subscriber records with optional filtering, sorting, and pagination.

Action Parameters

after
string
before
string
created_after
string
created_before
string
email_address
string
include_total_count
string
per_page
integer
sort_field
string
sort_order
string
status
string
updated_after
string
updated_before
string

Action Response

data
object
error
string
successful
boolean
Tool to retrieve subscribers for a specific form by id. use when you need to page or filter subscribers of a form.

Action Parameters

added_after
string
added_before
string
after
string
before
string
created_after
string
created_before
string
form_id
integerRequired
include_total_count
string
per_page
integer
status
string

Action Response

data
object
error
string
successful
boolean
Tool to retrieve a list of all tags. use when you need a complete inventory of tags for the kit account.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to retrieve subscribers for a specific tag. use after confirming the tag id when you need to list subscribers associated with a tag.

Action Parameters

after
string
before
string
created_after
string
created_before
string
include_total_count
string
per_page
integer
status
string
tag_id
integerRequired
tagged_after
string
tagged_before
string

Action Response

data
object
error
string
successful
boolean
Tool to associate a subscriber with a specific tag by id. use after confirming tag and subscriber ids when tagging a subscriber.

Action Parameters

subscriber_id
integerRequired
tag_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to associate a subscriber with a tag using an email address. use when you have a tag id and subscriber email ready. use after confirming both resources exist.

Action Parameters

email_address
Required
tag_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to update the list of colors for the account. use when customizing your kit account's color palette for broadcasts and templates.

Action Parameters

colors
arrayRequired

Action Response

data
object
error
string
successful
boolean
Tool to update a custom field's label. use after listing or retrieving custom fields and confirming the field id to rename.

Action Parameters

id
integerRequired
label
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to update a tag's name by id. use after retrieving tag id and confirming the new name.

Action Parameters

id
integerRequired
name
stringRequired

Action Response

data
object
error
string
successful
boolean