Kit integration: operations for AI agents
Kit connects to Type.com as an integration. This page lists the 85 operations documented for Claude and Codex in Type.com: 37 read, 28 write, 20 destructive.
About Kit
Kit is a platform that allows creators to automate tasks and developers to build apps for the Kit App Store.
Categories: Marketing & Social
How to connect Kit to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
85 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
85 operations listed.
Accounts
- Read
Get current account
Returns the authenticated account and user: account id, name, plantype, primary email address, timezone, and the account's sending addresses with their verification and DMARC status.
- Read
List colors
Returns the account's saved brand color palette as an array of hex codes (up to 10). These are the colors available in Kit's editors for emails, forms, and landing pages. To change the palette, use Update colors.
- Read
Get Creator Profile
Returns the account's Creator Profile — the public-facing identity shown on their Kit profile page and in the Creator Network: display name, byline, bio, imageurl, and the public profileurl.
- Read
Get email stats
Returns account-level email performance for the last 90 days: sent, opened, and clicked counts plus open, click, unsubscribe, and bounce rates, with the exact reporting window in starting/ending (emailstatsmode is last90).
- Read
Get growth stats
Get growth stats for a specific time period. Defaults to last 90 days. NOTE: We return your stats in your sending time zone. This endpoint does not return timestamps in UTC.
- Destructive
Update colors
Replaces the account's brand color palette with the provided array of up to 10 hex codes and returns the updated list. Note: this overwrites the entire palette rather than appending — include every color you want to keep. Returns 422 when a color code is invalid.
Broadcasts
- Read
List broadcasts
Returns a cursor-paginated list of broadcasts in the account with their content, targeting (subscriberfilter), email template, and web-publishing settings. Filter by lifecycle status (draft, scheduled, sending, completed, aborted) and by the sentafter/sentbefore timestamps.
- Read
Get stats for a list of broadcasts
Returns delivery and engagement stats — recipients, opens, clicks, unsubscribes, and their corresponding rates — for a page of broadcasts in a single request, avoiding a call per broadcast.
- Read
Get link clicks for a broadcast
Returns click performance for each link in a broadcast: the link url, its uniqueclicks, and its click-to-delivery and click-to-open rates. Useful for seeing which calls to action actually drove engagement.
- Read
Get stats for a broadcast
Returns delivery and engagement stats for a single broadcast: recipients, opens, clicks, unsubscribes, their corresponding rates, plus the sending status and progress.
- Read
Get a broadcast
Returns a single broadcast's full record: subject, content (HTML), preview text, targeting (subscriberfilter), email template, sending schedule (sendat), and web-publishing details (public, publicurl, publishedat).
- Write
Create a broadcast
Draft or schedule to send a broadcast to all or a subset of your subscribers. To save a draft, set sendat to null. To publish to the web, set public to true. To schedule the broadcast for sending, provide a sendat timestamp.
- Destructive
Update a broadcast
Update an existing broadcast. Continue to draft or schedule to send a broadcast to all or a subset of your subscribers. To save a draft, set public to false. To schedule the broadcast for sending, set public to true and provide sendat.
- Destructive
Delete a broadcast
Permanently deletes a draft or scheduled broadcast and returns 204 No Content on success. This is a hard delete and cannot be undone.
Custom Fields
- Read
List custom fields
A custom field allows you to collect subscriber information beyond the standard fields of first name and email address. An example would be a custom field called last name so you can get the full names of your subscribers.
- Write
Bulk create custom fields
See "Bulk & async processing" for more information.
- Write
Bulk update subscriber custom field values
Creates or updates custom field values for many subscribers in one request. Each entry in customfieldvalues pairs a subscriberid with a subscribercustomfieldid and the value to set. Requires OAuth authentication.
- Write
Create a custom field
Create a custom field for your account. The label field must be unique to your account. Whitespace will be removed from the beginning and the end of your label. Additionally, a key field and a name field will be generated for you.
- Destructive
Update a custom field
Updates a custom field label (see Create a custom field for more information on labels). Note that the key will change but the name remains the same when the label is updated.
- Destructive
Delete custom field
This will remove all data in this field from your subscribers.
Email Templates
- Read
List email templates
Returns a cursor-paginated list of the account's email templates with each template's id, name, isdefault flag, and category (for example HTML or Starting point). Use a template's id as the emailtemplateid when creating or updating a broadcast.
Forms
- Read
List forms
Returns a cursor-paginated list of forms and landing pages in the account. Both live on this endpoint — filter with type=embed for embedded forms or type=hosted for landing pages.
- Read
List subscribers for a form
Returns a cursor-paginated list of subscribers who joined through (or were added to) the form. By default only active subscribers are returned — use status (active, inactive, bounced, complained, cancelled, or all) to widen the search.
- Write
Bulk add subscribers to forms
Adding subscribers to double opt-in forms will trigger sending an Incentive Email. Subscribers already added to the specified form will not receive the Incentive Email again. For more information about double opt-in see "Double opt-in".
- Write
Add subscriber to form by email address
The subscriber being added to the form must already exist. Subscribers can be created using the "Create a subscriber" endpoint.
- Write
Add subscriber to form
The subscriber being added to the form must already exist. Subscribers can be created using the "Create a subscriber" endpoint.
Posts
- Read
List posts
Returns a cursor-paginated list of the account's posts — content published to the creator's Kit site and/or sent by email — with each post's status (e.g. draft, scheduled, published), slug, publicurl, ispaid flag, and timestamps for publishing and sending.
- Read
Get a post
Returns a single post's full record, including its content HTML, status (e.g. draft, scheduled, published), slug, SEO fields (description, metadescription), thumbnail, ispaid flag, and the publicurl where it's published on the creator's Kit site.
Purchases
- Read
List purchases
Returns a cursor-paginated list of purchases recorded in the account, typically imported from e-commerce platforms. Each purchase includes its transactionid, status, source (e.g.
- Read
Get a purchase
Returns a single purchase's details: transactionid, status, source, the buyer's emailaddress and subscriberid, monetary breakdown (subtotal, discount, tax, total, currency), transactiontime, and the purchased products with quantities and unit prices.
- Write
Create a purchase
Records a purchase against a subscriber, identified by emailaddress — use this to sync order data from your e-commerce platform into Kit so it appears on the subscriber's profile and can drive purchase-based automations.
Segments
- Read
List segments
Returns a cursor-paginated list of all segments in the account with their id, name, and creation date. Segments are created and managed in the Kit app — the API doesn't currently support creating or updating them.
Sequence Emails
- Read
List sequence emails
Returns every email inside a sequence, ordered by position (the order subscribers receive them). Each entry carries timing (delayvalue, delayunit, senddays), publish state (published), and metadata (subject, previewtext, emailtemplateid).
- Read
Get a sequence email
Fetches a single sequence email by id. Unlike List sequence emails, this endpoint always returns the full content — no includecontent flag needed.
- Write
Create a sequence email
Adds a single email to a sequence. Each sequence email represents one step subscribers receive on their journey through the sequence — its position determines order, and delayvalue / delayunit / senddays determine when it fires relative to either the previous email or the subscr…
- Destructive
Update a sequence email
Updates any field on a sequence email — subject, previewtext, content, delayvalue, delayunit, senddays, position, emailtemplateid, or published. Only fields included in the request body change; everything else is preserved.
- Destructive
Delete a sequence email
Permanently removes one email from a sequence. Warning: subscribers already queued to receive the deleted email will skip it — they'll continue to the next email in sequence order. This is intentional and not retryable.
Sequences
- Read
List sequences
Returns every sequence on the account. A sequence is a self-contained set of automated emails — subscribers join, then receive each email in order, governed by per-email delayvalue / delayunit and the sequence's overall senddays, sendhour, and timezone schedule.
- Read
Get a sequence
Fetches a single sequence by id. Use this when you need the current schedule, the active / repeat / hold flags, the configured emailaddress and emailtemplateid, or excludesubscribersources for a known sequence — for example, to confirm settings before adding subscribers or to re…
- Read
List subscribers for a sequence
Returns a cursor-paginated list of subscribers in the sequence, each with an addedat timestamp for when they entered it. By default only active subscribers are returned — use status (active, inactive, bounced, complained, cancelled, or all) to widen the search.
- Write
Create a sequence
Creates an empty sequence — the container that holds sequence emails. After creating the shell, use Create a sequence email to populate it. Only name is required.
- Write
Add subscriber to sequence by email address
The subscriber being added to the sequence must already exist. Subscribers can be created using the "Create a subscriber" endpoint.
- Write
Add subscriber to sequence
The subscriber being added to the sequence must already exist. Subscribers can be created using the "Create a subscriber" endpoint.
- Destructive
Update a sequence
Updates any sequence settings — name, emailaddress, schedule (senddays, sendhour, timezone), emailtemplateid, excludesubscribersources, or the active / repeat / hold flags. Only fields included in the request body change; everything else is preserved.
- Destructive
Delete a sequence
Soft-deletes a sequence. The sequence is removed from active delivery immediately, with cleanup of associated state happening in the background.
Snippets
- Read
List snippets
Returns every snippet on the account. Each snippet's key is the identifier used in Liquid — {{ snippet.key }} — when creating a broadcast or sequence email. See Create a snippet for how snippets work end-to-end.
- Read
Get a snippet
Fetches a single snippet by id. Unlike List snippets, this endpoint always returns the full content and document — no includecontent flag needed. Use this when you have an id (e.g.
- Write
Create a snippet
Snippets are reusable pieces of email content you can drop into a broadcast or sequence email using Liquid: {{ snippet.key }}. Update the snippet once and every email that references it picks up the new content on next send. There are two snippettypes.
- Destructive
Update a snippet
Rename a snippet, replace its body, or archive/restore it. Updates apply on the next send of any email that references the snippet via {{ snippet.key }} — there's no per-email versioning, so a content change ripples to every broadcast or sequence email using that key.
Subscribers
- Read
List subscribers
Returns a cursor-paginated list of subscribers in the account. By default only active subscribers are returned — use status (active, inactive, bounced, complained, cancelled, or all) to widen the search.
- Read
Get a subscriber
Returns a single subscriber's record: first name, email address, state (e.g. active or cancelled), creation date, and their custom field values under fields. To look a subscriber up by email address instead of id, use List subscribers with the emailaddress parameter.
- Read
List stats for a subscriber
Retrieve email stats for a specific subscriber: totals for sent, opened, clicked, and bounced emails, open and click rates, and recency signals (lastsent, lastopened, lastclicked, and sends since the last open/click).
- Read
List tags for a subscriber
Returns a cursor-paginated list of the tags currently applied to a subscriber, including when each was applied (taggedat). To see every tag in the account, use List tags. To add or remove a tag for this subscriber, use Tag a subscriber and Remove tag from subscriber.
- Write
Bulk create subscribers
See "Bulk & async processing" for more information.
- Write
Create a subscriber
Behaves as an upsert. If a subscriber with the provided email address does not exist, it creates one with the specified first name and state. If a subscriber with the provided email address already exists, it updates the first name.
- Write
Filter subscribers by engagement, sign-up date, state, and tags
Searches your subscriber list with compound conditions: email engagement (opens, clicks, sends, deliveries — with count thresholds and date ranges), sign-up date, subscriber state, and tags. Every condition in the all array must match (AND logic).
- Write
Unsubscribe subscriber
Unsubscribes the subscriber from all future emails, moving them to the cancelled state. Returns 204 No Content on success. The subscriber record, history, and tags are retained — they are not deleted from the account.
- Write
Pin a subscriber's location
Pins an explicit location to a subscriber, overriding any location Kit has inferred from open events. Provide city, stateprovince, countrycode (ISO 3166-1 alpha-2, required), latitude, longitude, and timezone (IANA timezone name, e.g. America/Denver).
- Write
Update a subscriber's pinned location
Updates a subscriber's pinned location. This is a full replacement, not a partial update: city, stateprovince, countrycode (ISO 3166-1 alpha-2), latitude, longitude, and timezone (IANA timezone name, e.g.
- Destructive
Update a subscriber
If you include a custom field key that does not exist on your account, the request returns an error. Use List custom fields to retrieve existing keys, or Create a custom field to add new fields before setting them for subscribers.
- Destructive
Delete a subscriber's location
Removes the subscriber's pinned location and returns 204 No Content on success. After deletion, Kit may re-infer the subscriber's location from future open events.
Tags
- Read
List tags
Returns a cursor-paginated list of all tags in the account with their id, name, and creation date. Add include=subscribercount to embed each tag's subscriber count.
- Read
List subscribers for a tag
Returns a cursor-paginated list of subscribers who have this tag. By default only active subscribers are returned — use status (active, inactive, bounced, complained, cancelled, or all) to widen the search.
- Write
Bulk create tags
See "Bulk & async processing" for more information.
- Write
Bulk tag subscribers
The subscribers being tagged must already exist. Subscribers can be created in bulk using the "Bulk create subscriber" endpoint. See "Bulk & async processing" for more information.
- Write
Create a tag
Creates a tag with the given name. Creation is idempotent on name (matched case-insensitively): if a tag with that name already exists, the endpoint returns 200 with the existing tag instead of creating a duplicate (a newly created tag returns 201).
- Write
Tag a subscriber by email address
The subscriber being tagged must already exist. Subscribers can be created using the "Create a subscriber" endpoint.
- Write
Tag a subscriber
The subscriber being tagged must already exist. Subscribers can be created using the "Create a subscriber" endpoint.
- Destructive
Bulk delete tags
See "Bulk & async processing" for more information.
- Destructive
Bulk remove tags from subscribers
See "Bulk & async processing" for more information.
- Destructive
Update tag name
Renames a tag. The tag keeps its id and all of its subscribers — only the name changes, and the new name is reflected everywhere the tag is used (forms, automations, filters).
- Destructive
Remove tag from subscriber by email address
Removes the tag from a subscriber identified by the emailaddress query parameter, returning 204 No Content. The subscriber stays in your account and keeps their other tags — only this tag association is removed.
- Destructive
Remove tag from subscriber
Removes the tag from the subscriber and returns 204 No Content. The subscriber stays in your account and keeps their other tags — only this tag association is removed. Returns 404 when the tag or subscriber id doesn't exist.
Webhooks
- Read
List webhook endpoints
Returns a paginated list of the account's webhook endpoints. Filter with status to return only active or disabled endpoints. OAuth app scoping: When authenticating with OAuth, this endpoint returns only webhooks created by your OAuth application.
- Read
Get a webhook endpoint
Returns a single webhook endpoint. The signing secret is never included — it's only returned when you create the endpoint or rotate the secret. Returns 404 when the id doesn't exist, belongs to another account, or belongs to an endpoint created by a different app.
- Read
List webhook deliveries
Returns a paginated list of deliveries for a webhook endpoint. Delivery history is retained for 30 days — older records are automatically removed.
- Read
Get webhook delivery details
Returns a single delivery record including its full attempt history — timestamps, HTTP status codes, and response bodies. Pass includepayload=true to also return the events that were sent.
- Write
Create a webhook endpoint
Registers a URL to receive deliveries for the event types listed in events. The url must be publicly reachable over HTTP(S) — private, internal, and loopback addresses are rejected. The response is the only time the signing secret is returned in plaintext.
- Write
Update a webhook endpoint
Updates any of name, url, description, status, and events. Set status to disabled to stop deliveries without deleting the endpoint, and back to active to resume.
- Write
Rotate a webhook endpoint secret
Generates a new signing secret for the endpoint and returns it. The response is the only time the new secret appears in plaintext — store it securely.
- Destructive
Delete a webhook endpoint
Deletes the webhook endpoint and stops all future deliveries of its subscribed events. Returns 204 No Content on success and 404 when the id doesn't exist or isn't visible to the caller.
- Destructive
Revoke the previous webhook endpoint secret
Closes a rotation's overlap window early: the previous secret stops verifying immediately, leaving only the current secret valid. Call this once you've fully switched to the new secret, rather than waiting for previoussecretexpiresat to pass.
Webhooks (Legacy)
- Read
List webhooks
Legacy: This is the previous generation of Kit webhooks. It keeps working and there are no plans to remove it, but it's superseded by webhook endpoints, which support many event types per endpoint, signed deliveries, and automatic retries — use those for new integrations.
- Write
Create a webhook
Legacy: This creates a previous-generation webhook. Existing webhooks keep working and there are no plans to remove them, but new integrations should use Create a webhook endpoint instead — one endpoint subscribes to many event types and gets signed, automatically retried delive…
- Destructive
Delete a webhook
Legacy: This deletes a previous-generation webhook. If you're replacing it rather than retiring it, consider recreating it as a webhook endpoint — see the webhooks guides. Deletes the webhook and stops all future deliveries of its subscribed events to the target URL.
No operations match.
See How connections work for access and permissions, or browse all integrations.