TextKit

Send one SMS from one of your numbers. Set category "marketing" for promotions (the opt-in check applies) and scheduled_at to send later. Quiet hours apply to every message: outside 8am-9pm (8pm in Florida, Maryland and Oklahoma) in the recipient's local time a marketing message is refused and anything else is held until 8am, except one-time codes and replies within 4 hours of their text. In sandbox (test keys), delivery is simulated: +15005550006 delivers, +15005550002 fails, +15005550007 is filtered as spam, +15005550013 delivers after a delay, +15005550016 has no opt-in (see /docs/sandbox).

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

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.

Empty a finished message's text and media everywhere it is kept, keeping its status, price and timeline (redacted_at is set). Cannot be undone.

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

Send a one-time verification code (OTP) to a phone number by text, or to an email address with channel "email". TextKit generates the code, handles expiry (10 min) and attempt limits (5), and blocks SMS-pumping and email-bombing abuse.

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.

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.

List the phone numbers on your account.

Ask our team for a short code (or a toll-free number they set up). Provisions nothing by itself; carriers take 8-12 weeks to approve a short code.

Open short-code and toll-free requests.

Takes no parameters.

Search purchasable numbers by area code (default 415).

Buy a phone number for your account (free sandbox numbers with test keys). Live numbers are billed monthly.

Release a number you own. It cannot be got back.

Look up line type (mobile, landline, VoIP) and carrier for any US/Canada number.

Sandbox only: simulate an inbound SMS to one of your test numbers (emits message.received; STOP, START and HELP act as for real).

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

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

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

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

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

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

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

Your numbers as CSV text.

List sender pools.

Takes no parameters.

Create a sender pool from numbers you own.

Retrieve a sender pool and its numbers.

Rename a sender pool or change its numbers.

Delete a sender pool. Its numbers are kept.

Copy a sender pool under a new name.

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.

Find out where an audience is and the ways to bring it in. Without source: questions to ask the person (where their people are, which group, what they can sign in to, whether consent was recorded, once or kept in sync) and the kinds of source known. With source (their words, e.g. "Mixpanel", "Shopify", "our Postgres users table", "a Google Sheet"): the ways in, best first, each with steps and a console link: an integration already syncing it, another connected tool that can read it, a 6-hourly sync connected with their key here or in the console, a push to an ingest URL, a script with a key from their environment, an export, or a CSV upload. Changes nothing.

Create a contact, or update the existing one with the same phone_number.

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

Retrieve a contact.

Update a contact. Only the inputs you pass change; tags and fields replace the whole list or map.

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

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

Subscribe a contact to a topic, or unsubscribe them (e.g. "promotions" vs "order updates").

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

List contact lists with their contact counts.

Takes no parameters.

Retrieve a list and its contact count.

Rename a list or change its description.

Delete a list (its contacts stay).

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

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

Remove contacts from a list (they stay contacts).

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.

List saved segments.

Takes no parameters.

Retrieve a segment and its rules.

Rename a segment or replace its rules.

Delete a segment. Contacts are not touched.

Count a cohort without saving anything (nothing appears in the console): run up to 10 segment rules now and get the counts (matched, opted out, eligible to text) and the first contacts. Examples: replied in the last 7 days (last_reply_at after 7d); got a batch and did not reply (batch sent, and batch replied with is_not); started checkout but never purchased (event exists, event not_exists); VIPs not texted in 30 days. Same rule fields as a saved segment. Everyone eligible to text: one rule, status is subscribed.

Count the contacts a segment matches right now and how many a broadcast would reach (opted-out contacts removed, and with topic_id those unsubscribed from it). `notes` says when an event rule names an event never tracked.

List subscription topics.

Takes no parameters.

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

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

List message templates.

Takes no parameters.

Retrieve a template.

Rename or edit a template.

Delete a template.

Which text should we send? Ranked SMS copy for a goal (abandoned_cart, welcome, winback, failed_payment, trial, promo, ... or any) by expected revenue per message, each with its evidence: the factors that moved its score, the closest published SMS-only case studies with source links, and how much comes from this account's own sends (clicks, STOPs, revenue from tracked events). Pass your own drafts in `candidates` to score them against the generated ones. Only uses the offer, code and deadline you give it. Sends and saves nothing.

Send one message to many people (a broadcast or campaign): pick recipients by segment_id, tags, contact_ids, or an explicit recipients list. Opted-out numbers, numbers without marketing consent, and people unsubscribed from topic_id are removed before sending. dry_run: true sends nothing and returns the count, cost, rejected rows and consent.no_opt_in (recipients the send will skip for having no opt-in). scheduled_at sends later (up to 30 days). shorten_links: true tracks link clicks. With a live key it texts real people.

List batches (broadcasts), newest first.

Retrieve a batch with its progress counts.

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

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

Pause a sending or scheduled batch.

Resume a paused batch.

Cancel a batch. Messages already sent stay sent.

Retry a batch's failed recipients.

Record something a customer did (e.g. signed_up, cart_abandoned, trial_ending), by user_id and/or phone. It starts or advances any active automation listening for that event.

The questions behind anything a person does here, with this account's options for each: send a text, buy or release a number, register for 10DLC, verify a toll-free number, request a short code, verification codes, a recurring text, a segment, template, list, topic, connecting a tool, a webhook, an API key, a link domain, a spend limit, a number pool, importing opt-outs, automations, broadcasts. task: a key or the person's words ("buy a number"); omit it for the list. Each question names the fields it fills; inputs lists every field the API takes; rules, gaps, and person_submits when the person files it in the console. Changes nothing.

Every input a send needs, as questions to ask the person, with this account's options for each. kind automation: the event that starts it (tracked events with their properties, and the Mixpanel events mapped to them), filters, how long after the event to text, the event that ends it, follow-ups, repeats, who gets it, the message, link, sender and topic. kind broadcast: audience, who to leave out, message, when, sender, topic, follow-up. Also who never gets the text (exclusions) and what is missing (gaps). Changes nothing.

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. 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. Drafts send nothing until activated.

List automations.

Takes no parameters.

Retrieve an automation with its trigger and steps.

Edit an automation (name, sender, trigger incl. trigger.cooldown_seconds, or steps). `steps` replaces every step; `step` replaces just the one with its id. Pass `if_updated_at` (the updated_at you read): an edit made by someone else since then answers 409 instead of being overwritten.

Delete an automation.

Turn an automation on, so tracked events start runs. With a live number it texts real people.

Pause an automation: no new runs start, and runs in progress wait where they are until it is activated again.

See an automation's texts exactly as they would go out, without sending: works on drafts. Pass sample event properties (e.g. {"amount": 9.99}) and optionally `to` for a contact's merge fields. Returns each send_sms step's final text (brand and opt-out wording added as we would), segments, encoding, estimated cost, and merge fields that would come out empty.

Text an automation's messages to your own verified phone or a verified recipient now, skipping waits and conditions, without activating it (drafts work). Pass sample event properties; `steps` sends only those step ids. No run starts and stats do not change. Texts from a live number are real and billed.

List an automation's runs, newest first.

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

Cancel a run in progress.

Retrieve a topic.

Rename or describe a topic.

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

A contact's subscription to each topic.

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

Record an opt-in or opt-out from your own system (CRM, checkout, a form). An opt-in for a marketing registration needs proof (source, when, the page).

List opted-out numbers (the suppression list).

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.

List single messages scheduled for later and not yet sent.

Takes no parameters.

Retrieve a pending scheduled message.

Cancel a scheduled message before it sends.

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.

List recurring schedules.

Takes no parameters.

Retrieve a recurring schedule with its recent occurrences.

Pause (active: false) or resume (active: true) a recurring schedule.

Delete a recurring schedule.

Prepaid credit balance and auto-recharge setting.

Takes no parameters.

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

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

Takes no parameters.

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

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

Takes no parameters.

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

List toll-free verifications and their status (draft, in_review with our team, submitted to the carriers, verified, rejected). A toll-free number texts the public only once verified.

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

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.

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

Takes no parameters.

One connected tool and its last sync.

Rename, pause or resume (status), or change an integration's settings or credentials (left-out credentials keep the stored ones). eventTriggers (Mixpanel) maps Mixpanel events to TextKit events; changing only those does not re-test credentials or resync.

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.

Sync a connected tool now (up to 6 times an hour) and get what changed.

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

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

List webhook endpoints.

Takes no parameters.

Change a webhook endpoint: URL, events, or turn it off (active: false).

Delete a webhook endpoint.

Replace a webhook endpoint's signing secret (returned once). expire_previous_in keeps the old one signing for that many seconds so the receiver can switch without dropping events.

Send a signed test.ping to a webhook endpoint and see what it answered.

Re-send every event that failed to reach a webhook endpoint in a window (default the last 24 hours, up to 7 days), after fixing the receiver.

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 links.jointextkit.com.

Takes no parameters.

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

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. Short links never go on a shared domain: carriers filter those.

Check a link domain's DNS records now. When both are found it is turned on (active) at once.

Retrieve a webhook endpoint.

Delivery attempts to your webhook endpoints, with response status codes.

Send an event again to one webhook endpoint (after fixing the receiver).

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

List your customers.

Retrieve a customer.

Rename a customer or change its external_id or metadata.

Delete a customer.

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

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.

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

Takes no parameters.

Revoke an API key of this mode. Immediate and permanent: anything using it stops working.

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.

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

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

Wait up to 25 seconds for the next events after a cursor (a reply, a delivery receipt), then return them.

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

Set or remove the monthly spend cap and its alert thresholds. Live sends over the cap are refused.

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

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