TextKit

Turn an automation on, so tracked events start runs. With a live number it texts real people. With no `from`, a number approved for its `category` must exist or `issues` says what is missing; `sender` shows the numbers it will use.

Add contacts to a list by contact_ids and/or phone_numbers (up to 1,000; numbers must already be contacts).

Platforms: attribute a number (and its messages and usage) to one of your customers, or clear it with customer_id null.

Buy several numbers in one area code at once (e.g. for a sender pool). Live numbers are billed monthly each.

Add tags to, remove tags from, or delete many contacts by id.

Act on many numbers at once: tag, untag, label, add to or remove from a pool, or release. Releasing cannot be undone.

Cancel a run in progress.

Cancel a batch. Messages already sent stay sent.

Cancel a scheduled message before it sends.

Check a verification code submitted by a user, by the phone or email it went to. Returns {verified, status, channel, charged}. Billed only when verified is true.

Copy a sender pool under a new name.

Connect a tool so its people sync in as contacts, in a list of their own, every 6 hours: Mixpanel (projectId, username, secret = a service account; sourceId = cohort id), Amplitude (apiKey, secretKey, sourceId), HubSpot (accessToken), Shopify (shopDomain, accessToken), Salesforce, or a webhook. Takes the event or property that shows people agreed to texts (consentEvent / consentField) and the property that holds their phone (phoneField). Credentials are proved with one read, sealed, and never returned. Mixpanel also takes eventTriggers, which turn Mixpanel events into TextKit events that start, end or branch automations; `warnings` names mapped events with no volume in 7 days.

Create an API key for an app you are building, to store as a secret in its environment (for example TEXTKIT_API_KEY) so the app can send texts itself. Same mode (test or live) as this connection; optional scopes limit it. The secret is returned once; the account owner is emailed.

Create a triggered text flow (as a draft): when trigger.event is tracked, run steps such as send_sms, wait, wait_for_event, and condition branches. Example: on cart_abandoned, wait 3600s, then if checkout_completed was not received send a reminder. A send_sms step with send_time: "optimal_user_time" and max_wait_seconds (60 to 86400, required) waits for the hour that person usually replies or clicks, 10am their time with no history, inside quiet hours: recommend it for marketing and lifecycle texts, leave it off anything time-sensitive, and it is refused for one-time codes and order or shipping texts. For events that repeat, trigger.cooldown_seconds stops the same person starting it again for that long. Merge fields like {{plan}} fill from the trigger event's properties; `issues` names any no tracked event carries. Leave out `from` and TextKit picks a number approved for `category` (marketing, transactional for alerts, otp for codes) when it sends; `sender` shows the numbers, and `issues` says so when none is approved yet. Pass `from` only to pin a number. Drafts send nothing until activated.

Platforms sending for other businesses: create a customer to attribute numbers, messages and usage to.

Make a tracked short link to copy into a text, ad, email or anywhere else: returns short_url. The same url again returns the same link. Suggest this whenever someone wants to know whether a link gets clicked or leads to sales. A link inside a text needs only shorten_links: true on the send.

Add a subdomain of the user's own (links.example.com) for short links. Returns two DNS records (CNAME and TXT) the user adds at their DNS host; then verify the domain. Optional: without one, tracked links use our domain.

Create a list: a fixed group of contacts (Audience → Lists). Membership is set by hand, unlike a segment, which follows rules.

Create a sender pool from numbers you own.

Create a 10DLC registration (the carrier registration local numbers need to text the public) and check it: the website, privacy policy, terms, opt-in page and example texts against carrier rules. Returns ready or checks_failed, with each finding, its fix and copy to paste. Nothing goes to the carriers and nothing is billed. Business details come from the person, not from guesses.

Send the same text to one number every day, week or month at a local time (e.g. a weekly reminder). Every occurrence runs the usual send checks.

Save an audience (a segment, a cohort): it appears in the console under Audience → Segments, and broadcasts can be sent to it. Everyone who can be texted: one rule, status is subscribed. Contacts matching all (or any) of up to 10 rules. Attributes: tags, contact fields, custom fields (field = "field", key = the name), opt-in status, topic, import, created_at. Behaviour: last_message_at, last_reply_at, batch (key = batch id; value included, sent, failed, skipped or replied) and event (key = a tracked event name). Times take an ISO date or a window like 7d. It is evaluated live each time it is used, so a batch or list sent to it reaches whoever matches then.

Save a message template. Merge tags: {{first_name}}, {{name}}, {{phone}}, {{field:<custom>}}, and per-recipient variables.

Start the carriers' toll-free verification for live toll-free numbers, filled in from the account, its registration, hosted opt-in page and website; any field sent replaces what was filled in. Returns a draft with problems: what the carriers would reject. Nothing goes to the carriers and there is no fee.

Create a subscription topic, so people can opt out of one kind of message (e.g. promotions) and keep others.

Send events (message.received, message.delivered, message.opted_out, ...) to a URL: your app, a CRM, an automation tool. Returns the signing secret once.

Delete an automation.

Delete a contact. Messages, consent records, and topic preferences for the number are kept.

Delete a customer.

Remove a branded link domain. Every short link already sent on it stops working.

Delete a list (its contacts stay).

Delete a finished message (delivered, failed or received) and every copy of its text, for a privacy request. Opt-out records and billing are kept. Cannot be undone.

Delete a sender pool. Its numbers are kept.

Delete a recurring schedule.

Delete a segment. Contacts are not touched.

Delete a template.

Delete a topic you created (built-in topics stay).

Delete a webhook endpoint.

Disconnect a tool: its credentials and its list are deleted; the contacts stay with their consent.

A sole proprietor's registration: the code texted to their mobile after submitting (it lasts 24 hours). The right code sends the campaign to carrier review. The person reads it from their phone.

The suppression list, or the full consent ledger with opt-in proof, as CSV text.

Export as CSV text for analysis: messages, deliveries, events, opt_outs, webhook_deliveries, usage, usage_monthly, audit_log or credit_history. At most 50,000 rows; narrow the date range with from and to.

Your numbers as CSV text.

The text did not arrive: email a new code for the same pending verification (one id, one charge). The emailed code replaces the texted one and is checked by the email address, which it proves (not the phone). Once per verification.

Privacy erasure: forget the phone number linked to a user_id, so its tracked events stop reaching automations.

Retrieve an automation with its trigger and steps.

Retrieve one run with its step-by-step timeline.

Prepaid credit balance and auto-recharge setting.

Retrieve a batch with its progress counts.

Results of a batch: delivered, failed, pending, replies, opt-outs (stops), spend, and failures grouped by reason.

Whether a number is opted in or out, per registration, with its full consent history and proof.

Retrieve a contact.

A contact's subscription to each topic.

Retrieve a customer.

A customer's messages, verifications and spend for a period.

Delivery rates by day, destination carrier, or sending number.

One connected tool and its last sync.

Confirm the events behind automations: for a Mixpanel integration, each mapped event with its Mixpanel source events and their 7-day volume, how many reached TextKit and when the last did, and which automations start on, wait for or check it. `missing` names events automations rely on that nothing sends. project_events: true also lists every Mixpanel event name with its 7-day volume, to choose what to map.

One short-link domain, with the DNS records it needs.

Retrieve a list and its contact count.

Retrieve a message by its msg_... id, with its delivery timeline.

Retrieve one of your numbers: status, sender registration, tags, pools, customer.

Retrieve a sender pool and its numbers.

A registration with its checks, status, and linked numbers.

Retrieve a recurring schedule with its recent occurrences.

Retrieve a pending scheduled message.

Retrieve a segment and its rules.

The monthly spend limit and this month's estimated spend.

Retrieve a template.

A toll-free verification: status, numbers, the form, what is missing (problems), and the carriers' reason when it was rejected.

Retrieve a topic.

Usage by month, today's counters, and plan limits.

Retrieve a verification by id: its status and attempts (never the code).

Retrieve a webhook endpoint.

Create or update up to 500 contacts per call, matched by phone_number. Attributes go in fields (up to 20 strings, e.g. plan) for segments and {{field:name}} merge tags; tags group contacts. opt_in carries consent evidence (status: false records an opt-out). import_id from the first response groups several calls; dry_run: true returns what would change and writes nothing.

Bring a suppression list over from another provider or tool (up to 500 numbers per call), so people who opted out there are never texted here.

Attach a number to an approved 10DLC registration so it can send that registration's traffic.

List the active API keys of this mode (never the secrets).

Who changed what on the account (keys, team, webhooks, spend limit, numbers, consent, settings), newest first.

List an automation's runs, newest first.

List automations.

List a batch's recipients with each one's status.

List batches (broadcasts), newest first.

List contacts, newest first. Filter by tag, segment_id, list_id, exact phone_number, or a free-text q (name, email, company).

The latest 100 conversions, newest first.

List your customers.

List recent events (message.sent/delivered/failed/received, number.purchased/released, ...), newest first.

The connected tools: status, settings, last sync (found, added, opted out), and their list. No credentials.

Your short-link domains and their status (pending_dns, dns_verified, active). Optional: a message sent with shorten_links: true uses the active one, else <your business>.txtkto.com once the business is verified, or txtkto.com before that.

Every tracked destination with its texts, clicks, conversions and value. The answer to "which link worked?".

Page through a list's contacts, most recently added first.

List contact lists with their contact counts.

List your messages, newest first. Filter by number, direction, status, failure reason, date, batch schedule or customer.

List sender pools.

Open short-code and toll-free requests.

List the phone numbers on your account.

List opted-out numbers (the suppression list).

The filed copies of a 10DLC registration, newest first.

List 10DLC brand and campaign registrations and their status. Marketing from a local number needs an approved one.

List single messages scheduled for later and not yet sent.