Directory / Work & productivity
TextKit
Send and receive SMS, verify phone numbers, buy US and Canada numbers, and manage contacts, segments, broadcasts and automations. OAuth sign-in or an API key as a Bearer token; free sandbox keys at sign-up. Endpoint: https://mcp.jointextkit.com · Website · Registry: com.jointextkit/textkit
Live Answered an MCP handshake without credentials and listed 161 tools.
- Category
- Work & productivity
- Transport
http- Source
- https://jointextkit.com/docs/mcp
- Endpoint
https://mcp.jointextkit.com- MCP Registry
com.jointextkit/textkit- Reports itself as
- textkit 1.0.0+21b9a036
- Protocol
- 2025-03-26
- Tools
- 161
- Context cost
- about 34,381 tokens for the tool definitions (estimated at four characters per token)
- Tool definitions last changed
- no change seen since first check
- Handshake time
- 373 ms
- Last checked
- 2026-11-22 11:27:51 UTC
- Listed since
- 2026-11-18
Health and compatibility
| Endpoint reachable | Verified | Responded in 373 ms |
|---|---|---|
| MCP handshake (initialize) | Verified | Completed without credentials |
| Tool discovery (tools/list) | Verified | 161 tools listed |
| Authentication | Verified | None needed to connect |
| Protocol version | Verified | 2025-03-26 |
| Transport | Verified | Streamable HTTP |
| Capabilities declared | Verified | prompts, tools |
Last checked . Verified means the check saw it happen; it says nothing about whether the server is safe.
Recent history
5 daily checks so far; median response 294 ms. Green answered, violet asked for auth, red did not answer.
Set up in your client
Claude Code
Run this in a terminal:
claude mcp add --transport http textkit https://mcp.jointextkit.comClaude Desktop
Open Settings → Connectors → Add custom connector and paste this URL:
https://mcp.jointextkit.comOr bridge it through mcp-remote in claude_desktop_config.json (needs Node.js):
{
"mcpServers": {
"textkit": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://mcp.jointextkit.com"
]
}
}
}Cursor
Or add it to ~/.cursor/mcp.json (or .cursor/mcp.json in a project):
{
"mcpServers": {
"textkit": {
"url": "https://mcp.jointextkit.com"
}
}
}VS Code
Or add it to .vscode/mcp.json:
{
"servers": {
"textkit": {
"type": "http",
"url": "https://mcp.jointextkit.com"
}
}
}Or from a terminal:
code --add-mcp '{"name": "textkit", "type": "http", "url": "https://mcp.jointextkit.com"}'Windsurf
Add it to ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"textkit": {
"serverUrl": "https://mcp.jointextkit.com"
}
}
}Other clients
Most clients accept this shape. The endpoint is:
https://mcp.jointextkit.com{
"mcpServers": {
"textkit": {
"type": "http",
"url": "https://mcp.jointextkit.com"
}
}
}If it does not connect
- Restart the client after editing a config file, and keep keys out of files you commit.
- If the tools do not appear, open the client's MCP log: a 401 means the credentials were not accepted, and a timeout means the server did not answer.
Tools 161
Names, descriptions and input schemas exactly as the server returned them on 2026-11-22. This is the server author's own text. Nothing is run from this page. Labels such as read-only are declared by the server and are not verified. Raw JSON
activate_automationcan modifydestructiveexternal accessTurn an automation on, so tracked events start runs. With a live number it texts real people. With no `from`, …
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.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Automation id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "activate_automation",
"arguments": {
"id": "..."
}
}
}add_to_listcan modifydestructiveAdd contacts to a list by contact_ids and/or phone_numbers (up to 1,000; numbers must already be contacts).
Add contacts to a list by contact_ids and/or phone_numbers (up to 1,000; numbers must already be contacts).
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | List id |
contact_ids | string[] | optional | Contact ids |
phone_numbers | string[] | optional | Phone numbers in E.164, of existing contacts |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "add_to_list",
"arguments": {
"id": "..."
}
}
}assign_number_to_customercan modifydestructivePlatforms: attribute a number (and its messages and usage) to one of your customers, or clear it with …
Platforms: attribute a number (and its messages and usage) to one of your customers, or clear it with customer_id null.
| Parameter | Type | Description | |
|---|---|---|---|
phone_number | string | required | E.164 number you own |
customer_id | string | required | A customer id, or null to unassign |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "assign_number_to_customer",
"arguments": {
"phone_number": "...",
"customer_id": "..."
}
}
}bulk_purchase_numberscan modifydestructiveexternal accessBuy several numbers in one area code at once (e.g. for a sender pool). Live numbers are billed monthly each.
Buy several numbers in one area code at once (e.g. for a sender pool). Live numbers are billed monthly each.
| Parameter | Type | Description | |
|---|---|---|---|
area_code | string | required | Three-digit area code to buy in |
quantity | integer | required | How many numbers to buy (1 to 50) |
pool_id | string | optional | Add the new numbers to this pool |
tags | string[] | optional | Tags to put on the new numbers |
idempotency_key | string | optional | Optional. Retries are already safe: the same call with the same inputs within 10 minutes is done once and answers with the first result. Pass your own key to dedupe across a longer gap, or a new one to repeat an identical call on purpose. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "bulk_purchase_numbers",
"arguments": {
"area_code": "...",
"quantity": 0
}
}
}bulk_update_contactscan modifydestructiveAdd tags to, remove tags from, or delete many contacts by id.
Add tags to, remove tags from, or delete many contacts by id.
| Parameter | Type | Description | |
|---|---|---|---|
action | string | required | add_tags and remove_tags take tags, delete removes the contacts One of: add_tags, remove_tags, delete |
ids | string[] | required | Contact ids, up to 500 |
tags | string[] | optional | Required for add_tags and remove_tags |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "bulk_update_contacts",
"arguments": {
"action": "add_tags",
"ids": []
}
}
}bulk_update_numberscan modifydestructiveexternal accessAct on many numbers at once: tag, untag, label, add to or remove from a pool, or release. Releasing cannot be …
Act on many numbers at once: tag, untag, label, add to or remove from a pool, or release. Releasing cannot be undone.
| Parameter | Type | Description | |
|---|---|---|---|
ids | string[] | required | Numbers to act on, in E.164 |
action | string | required | add_to_pool and remove_from_pool take pool_id, add_tags and remove_tags take tags, set_label takes label, release takes confirm One of: add_to_pool, remove_from_pool, add_tags, remove_tags, set_label, release |
pool_id | string | optional | add_to_pool / remove_from_pool |
tags | string[] | optional | add_tags / remove_tags. Lowercased; up to 20 per number. |
label | string | optional | set_label; null clears |
confirm | string | optional | release only |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "bulk_update_numbers",
"arguments": {
"ids": [],
"action": "add_to_pool"
}
}
}cancel_automation_runcan modifydestructiveCancel a run in progress.
Cancel a run in progress.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Automation id |
run_id | string | required | Run id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "cancel_automation_run",
"arguments": {
"id": "...",
"run_id": "..."
}
}
}cancel_batchcan modifydestructiveCancel a batch. Messages already sent stay sent.
Cancel a batch. Messages already sent stay sent.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Batch id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "cancel_batch",
"arguments": {
"id": "..."
}
}
}cancel_scheduled_messagecan modifydestructiveCancel a scheduled message before it sends.
Cancel a scheduled message before it sends.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Scheduled message id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "cancel_scheduled_message",
"arguments": {
"id": "..."
}
}
}check_verificationcan modifydestructiveCheck a verification code submitted by a user, by the phone or email it went to. Returns {verified, status, …
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.
| Parameter | Type | Description | |
|---|---|---|---|
phone | string | optional | The number the code was texted to. Send this or `email`. |
email | string | optional | The address the code was emailed to. After a fallback, check by `email`: the code proves the address, not the phone, and a check by `phone` answers 409 `invalid_state`. |
code | string | required | The code last sent |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "check_verification",
"arguments": {
"code": "..."
}
}
}clone_number_poolcan modifydestructiveCopy a sender pool under a new name.
Copy a sender pool under a new name.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Pool id |
name | string | optional | Name of the new pool |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "clone_number_pool",
"arguments": {
"id": "..."
}
}
}connect_integrationcan modifydestructiveexternal accessConnect a tool so its people sync in as contacts, in a list of their own, every 6 hours: Mixpanel (projectId, …
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 …
| Parameter | Type | Description | |
|---|---|---|---|
provider | string | required | The tool to connect One of: shopify, hubspot, salesforce, mixpanel, amplitude, webhook |
mode | string | optional | Mixpanel / Amplitude: pull with credentials every 6 hours (default when credentials are sent), or push: no credentials, the tool's cohort sync posts to the ingest URL. One of: pull, push |
name | string | optional | What to call it (default: the tool and its source). |
sourceId | string | optional | Mixpanel or Amplitude cohort id; HubSpot list id; Salesforce campaign id; a Shopify customer search. Blank = everyone (HubSpot, Shopify, Salesforce). |
projectId | string | optional | Mixpanel project id. |
region | string | optional | Mixpanel / Amplitude data residency. One of: us, eu |
username | string | optional | Mixpanel service account username. |
secret | string | optional | Mixpanel service account secret. |
apiKey | string | optional | Amplitude API key. |
secretKey | string | optional | Amplitude secret key. |
accessToken | string | optional | HubSpot private app token, or Shopify Admin API access token. |
shopDomain | string | optional | Shopify store, like acme.myshopify.com. |
instanceUrl | string | optional | Salesforce My Domain URL. |
sfObject | string | optional | Salesforce: the object to sync One of: Contact, Lead |
clientId | string | optional | Salesforce consumer key, or Shopify client id. |
clientSecret | string | optional | Salesforce consumer secret, or Shopify client secret. |
phoneField | string | optional | The tool's property holding the mobile number, when not the usual one ($phone, phone, mobilephone). |
consentField | string | optional | The tool's property that records SMS consent (e.g. sms_opt_in). |
consentEvent | string | optional | Mixpanel / Amplitude: the opt-in event the cohort is built on (e.g. SMS Opt In). Everyone in the cohort is recorded as opted in, from that event. |
phoneEvent | string | optional | Mixpanel: an event that carries the number when profiles do not (e.g. Verification Check Success). A member with no phone on the profile gets it from their latest such event. |
phoneEventProperty | string | optional | Mixpanel: that event's property holding the number (default phone). |
exportEvents | boolean | optional | Mixpanel (with a service account): send each text's events onto the person's Mixpanel profile: TextKit Message Sent, Delivered, Failed, Link Clicked, Reply Received and Opted Out, with the message, batch or automation and step ids and names. The person is … |
eventTriggers | object[] | optional | Mixpanel (with a service account): events to turn into TextKit events within about 10 minutes, so automations start, wait and branch on them. Each entry is a TextKit event name and the Mixpanel events that count as it, like { event: "purchase_completed", … |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "connect_integration",
"arguments": {
"provider": "shopify"
}
}
}create_api_keycan modifydestructiveCreate an API key for an app you are building, to store as a secret in its environment (for example …
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.
| Parameter | Type | Description | |
|---|---|---|---|
name | string | required | What the key is for, e.g. "Booking app" |
scopes | string[] | optional | Limit the key to these scopes (see /docs/authentication). Omit for full access (full-access callers only). |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_api_key",
"arguments": {
"name": "..."
}
}
}create_automationcan modifydestructiveCreate a triggered text flow (as a draft): when trigger.event is tracked, run steps such as send_sms, wait, …
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 …
| Parameter | Type | Description | |
|---|---|---|---|
name | string | optional | Automation name |
from | string | optional | One of your numbers, to pin the flow to it. Leave it out and TextKit picks a number approved for `category`. A sandbox number makes it a sandbox flow. |
category | string | optional | What it sends: marketing, alerts (transactional) or codes (otp). With no `from`, TextKit picks a number approved for this. Falls back to a built-in topic. One of: marketing, transactional, otp |
topic_id | string | optional | Skip recipients unsubscribed from this topic. |
trigger | object | optional | What starts a run: an event, with optional filters |
steps | object[] | optional | Up to 20 steps, run in order |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_automation",
"arguments": {}
}
}create_customercan modifydestructivePlatforms sending for other businesses: create a customer to attribute numbers, messages and usage to.
Platforms sending for other businesses: create a customer to attribute numbers, messages and usage to.
| Parameter | Type | Description | |
|---|---|---|---|
name | string | optional | The customer's name |
external_id | string | optional | Your id for them; unique per account |
metadata | object | optional | Up to 50 string values |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_customer",
"arguments": {}
}
}create_linkcan modifydestructiveMake a tracked short link to copy into a text, ad, email or anywhere else: returns short_url. The same url …
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.
| Parameter | Type | Description | |
|---|---|---|---|
url | string | required | Where the link goes. Public shorteners and look-alike domains are refused. |
name | string | optional | Optional. Your name for it. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_link",
"arguments": {
"url": "..."
}
}
}create_link_domaincan modifydestructiveAdd a subdomain of the user's own (links.example.com) for short links. Returns two DNS records (CNAME and …
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.
| Parameter | Type | Description | |
|---|---|---|---|
domain | string | required | A subdomain you own, like links.example.com |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_link_domain",
"arguments": {
"domain": "..."
}
}
}create_listcan modifydestructiveCreate a list: a fixed group of contacts (Audience → Lists). Membership is set by hand, unlike a segment, …
Create a list: a fixed group of contacts (Audience → Lists). Membership is set by hand, unlike a segment, which follows rules.
| Parameter | Type | Description | |
|---|---|---|---|
name | string | optional | List name |
description | string | optional | What the list is for |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_list",
"arguments": {}
}
}create_number_poolcan modifydestructiveCreate a sender pool from numbers you own.
Create a sender pool from numbers you own.
| Parameter | Type | Description | |
|---|---|---|---|
name | string | required | Pool name |
description | string | optional | What the pool is for |
routing | string | optional | How a recipient gets a number. sticky: the same member every time. local: a member in the recipient's area code, else one in their time zone, else any; still the same one each time. One of: sticky, local |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_number_pool",
"arguments": {
"name": "..."
}
}
}create_registrationcan modifydestructiveexternal accessCreate a 10DLC registration (the carrier registration local numbers need to text the public) and check it: …
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.
| Parameter | Type | Description | |
|---|---|---|---|
business_name | string | required | The name customers know the business by, as the texts will name it. |
website | string | required | The business's own website. Reviewers visit it to confirm the business is real. |
use_case | string | required | What the texts are for. marketing and mixed need an opt-in for each person. One of: 2fa, account_notification, customer_care, delivery_notification, fraud_alert, higher_education, marketing, mixed … |
opt_in_url | string | optional | Page where people enter their number |
opt_in_screenshot_url | string | optional | People opt in inside an app: a public link to an image of that screen. Checked in place of a phone field and filed with the opt-in. null clears it. |
privacy_url | string | optional | Discovered from homepage links when omitted |
terms_url | string | optional | Discovered from homepage links when omitted |
support_email | string | optional | Used in the generated HELP reply |
sample_messages | string[] | optional | Real examples of the texts you will send, as a recipient would get them (no template variables). Carriers compare them with your traffic. Each must name your business; marketing and mixed use cases need opt-out wording in at least one. More than 5, or one … |
starter_messages | string[] | optional | Draft examples suggested for this business (fields.sample_messages from POST /registrations/prefill). Shown instead of the template starter drafts; samples_source stays starter and they are never filed until you edit or confirm them. Drafts that would not … |
samples_confirmed | boolean | optional | true = the starter drafts are right as they are; they become your examples. Ignored when sample_messages is sent. |
description | string | optional | What you send and to whom (40 to 500 characters). Omit or null to file the generated one. |
opt_in_flow | string | optional | How people opt in, in your own words. It leads the filed opt-in account; the opt-in page, the disclosure and the START keyword are added after it. Omit or null to file the standard sentence. |
stop_reply | string | optional | Your wording of the confirmation sent when someone opts out. It must name your business, say they are unsubscribed, and carry no link; anything else is a 400 naming what is missing. Omit or null for the standard wording in your business name. Filed with the … |
help_reply | string | optional | Your wording of the HELP reply. It must name your business, give a way to reach you (email, phone or web page) and keep the STOP instruction. Omit or null for the standard wording. |
includes_links | boolean | optional | Your messages include web links. Also true whenever an example contains one. |
includes_phone_numbers | boolean | optional | Your messages include phone numbers. Also true whenever an example contains one. |
age_gated | boolean | optional | Your messages are for adults only (alcohol, cannabis, gambling). |
direct_lending | boolean | optional | Your messages are about loans you make yourself. |
brand | object | optional | The business as the carriers register it. street must be a street address, not a P.O. box; state a 2-letter US state or territory code; postal_code a 5-digit ZIP (optionally +4). Anything else is refused with 400 naming the field. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_registration",
"arguments": {
"business_name": "...",
"website": "...",
"use_case": "2fa"
}
}
}create_schedulecan modifydestructiveexternal accessSend the same text to one number every day, week or month at a local time (e.g. a weekly reminder). Every …
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.
| Parameter | Type | Description | |
|---|---|---|---|
to | string | required | Recipient's number in E.164 |
from | string | optional | One of your numbers. Optional when the account has exactly one number for the key's mode. |
body | string | required | The text sent each time |
repeat | object | required | When it sends: how often, the local time and the time zone |
start_date | string | optional | First local date it may run. Defaults to today. |
end_date | string | optional | Last local date it may run (inclusive). |
max_occurrences | integer | optional | The schedule completes after this many messages have been sent. |
category | string | optional | Optional. It can make each occurrence stricter (`marketing`), never looser: the sending number's registration and the wording decide ([which messages are marketing](/docs/compliance-checks#which-messages-are-marketing)). One of: marketing, transactional, otp |
quiet_hours | string | optional | Optional. What to do with a message in the recipient's quiet hours: `block` refuses it (403 quiet_hours), `defer` holds it until their next 9:00am. Omitted: an occurrence in quiet hours is held until the recipient's 8:00am and recorded as `deferred`. One of: block, defer |
idempotency_key | string | optional | Optional. Retries are already safe: the same call with the same inputs within 10 minutes is done once and answers with the first result. Pass your own key to dedupe across a longer gap, or a new one to repeat an identical call on purpose. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_schedule",
"arguments": {
"to": "...",
"body": "...",
"repeat": {}
}
}
}create_segmentcan modifydestructiveSave an audience (a segment, a cohort): it appears in the console under Audience → Segments, and broadcasts …
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 …
| Parameter | Type | Description | |
|---|---|---|---|
name | string | optional | Segment name |
description | string | optional | What the segment is for |
match | string | optional | all: a contact must match every rule. any: at least one rule One of: all, any |
rules | object[] | optional | Up to 10 rules that decide who matches |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_segment",
"arguments": {}
}
}create_templatecan modifydestructiveSave a message template. Merge tags: {{first_name}}, {{name}}, {{phone}}, {{field:<custom>}}, and …
Save a message template. Merge tags: {{first_name}}, {{name}}, {{phone}}, {{field:<custom>}}, and per-recipient variables.
| Parameter | Type | Description | |
|---|---|---|---|
name | string | required | Template name |
body | string | required | The message text, with merge tags |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_template",
"arguments": {
"name": "...",
"body": "..."
}
}
}create_toll_free_verificationcan modifydestructiveStart the carriers' toll-free verification for live toll-free numbers, filled in from the account, its …
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. Submitting needs a paid account (the free credit does not count); otherwise point the person to a local number with 10DLC registration.
| Parameter | Type | Description | |
|---|---|---|---|
numbers | string[] | optional | Your live toll-free numbers this program texts from, E.164. One per business unless multiple_numbers_reason says why. |
multiple_numbers_reason | string | optional | Why the program needs more than one number (one per store, say). Required with more than one number. |
business_name | string | optional | The legal name, as on the IRS EIN letter, optionally with "d/b/a" and the brand your messages carry. |
ein | string | optional | The EIN (US), matching the legal name; elsewhere the business registration number. |
entity_type | string | optional | The kind of business. One of: PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT, SOLE_PROPRIETOR |
street | string | optional | Street address of the business. |
city | string | optional | City. |
state | string | optional | State or province code. |
postal_code | string | optional | ZIP or postal code. |
country | string | optional | Country of the business. |
contact_first_name | string | optional | First name of the person the carriers can contact about this program. |
contact_last_name | string | optional | Their last name. |
contact_phone | string | optional | A phone number they answer. |
brand_email | string | optional | The business's own email, for its customers: the HELP reply and the hosted opt-in page name it. |
website | string | optional | The business's website. |
use_case | string | optional | What the texts are for. One of: 2fa, account_notification, customer_care, delivery_notification, fraud_alert, higher_education, marketing, mixed … |
use_case_summary | string | optional | What the program sends, to whom and why. At least 40 characters. |
sample_messages | string[] | optional | At least two example messages. |
help_reply | string | optional | The reply to HELP: names the business and how to reach it. Omit to keep ours. |
stop_reply | string | optional | The reply to STOP: names the business and says they are unsubscribed. Omit to keep ours. |
opt_in_description | string | optional | How people opt in, step by step. At least 40 characters. |
opt_in_url | string | optional | The opt-in page. With none of your own we make you a hosted one. |
opt_in_screenshot_url | string | optional | A public image of the step where people enter their number and agree. Needed when the opt-in page itself has no phone field, like a later step of a form or an app. |
monthly_volume | string | optional | How many texts a month this program sends. |
volume_basis | string | optional | existing: what it sends today. projecting: an estimate. One of: existing, projecting |
advertising | string | optional | Whether the messages advertise a product or service. One of: yes, no, unsure |
previous_service | string | optional | Where this traffic ran before. One of: new, short_code, long_number |
previous_content | string | optional | Sample messages from the previous service (not new only). |
previous_numbers | string | optional | The numbers it used (not new only). |
number_published | string | optional | Where people see this number. |
fortune_500 | boolean | optional | The company is in the Fortune 500. |
urls_in_messages | string | optional | Links your messages include, or "None". |
phones_in_messages | string | optional | Phone numbers your messages include, or "None". |
terms_url | string | optional | The terms page, with the SMS program terms. |
privacy_url | string | optional | The privacy policy page. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_toll_free_verification",
"arguments": {}
}
}create_topiccan modifydestructiveCreate a subscription topic, so people can opt out of one kind of message (e.g. promotions) and keep others.
Create a subscription topic, so people can opt out of one kind of message (e.g. promotions) and keep others.
| Parameter | Type | Description | |
|---|---|---|---|
name | string | required | Topic name |
description | string | optional | What the topic covers |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_topic",
"arguments": {
"name": "..."
}
}
}create_webhookcan modifydestructiveexternal accessSend events (message.received, message.delivered, message.opted_out, ...) to a URL: your app, a CRM, an …
Send events (message.received, message.delivered, message.opted_out, ...) to a URL: your app, a CRM, an automation tool. Returns the signing secret once.
| Parameter | Type | Description | |
|---|---|---|---|
url | string | required | The https URL that receives the events |
events | string | string[] | optional | Event types to receive. Omit, or send "*" or [], for every event. An unknown type is a 400. |
description | string | optional | A note on what the endpoint is for |
numbers | string[] | optional | Optional. Only events about these of your numbers (E.164): message events by their from/to, number events by phone_number. Events about no number (batches, credits, registrations) go only to endpoints without a filter. Omit or [] for every number. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "create_webhook",
"arguments": {
"url": "..."
}
}
}delete_automationcan modifydestructiveDelete an automation.
Delete an automation.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Automation id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "delete_automation",
"arguments": {
"id": "..."
}
}
}delete_contactcan modifydestructiveDelete a contact. Messages, consent records, and topic preferences for the number are kept.
Delete a contact. Messages, consent records, and topic preferences for the number are kept.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Contact id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "delete_contact",
"arguments": {
"id": "..."
}
}
}delete_customercan modifydestructiveDelete a customer.
Delete a customer.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Customer id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "delete_customer",
"arguments": {
"id": "..."
}
}
}delete_link_domaincan modifydestructiveRemove a branded link domain. Every short link already sent on it stops working.
Remove a branded link domain. Every short link already sent on it stops working.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Link domain id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "delete_link_domain",
"arguments": {
"id": "..."
}
}
}delete_listcan modifydestructiveDelete a list (its contacts stay).
Delete a list (its contacts stay).
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | List id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "delete_list",
"arguments": {
"id": "..."
}
}
}delete_messagecan modifydestructiveDelete a finished message (delivered, failed or received) and every copy of its text, for a privacy request. …
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.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Message id (msg_...) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "delete_message",
"arguments": {
"id": "..."
}
}
}delete_number_poolcan modifydestructiveDelete a sender pool. Its numbers are kept.
Delete a sender pool. Its numbers are kept.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Pool id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "delete_number_pool",
"arguments": {
"id": "..."
}
}
}delete_schedulecan modifydestructiveDelete a recurring schedule.
Delete a recurring schedule.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Schedule id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "delete_schedule",
"arguments": {
"id": "..."
}
}
}delete_segmentcan modifydestructiveDelete a segment. Contacts are not touched.
Delete a segment. Contacts are not touched.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Segment id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "delete_segment",
"arguments": {
"id": "..."
}
}
}delete_templatecan modifydestructiveDelete a template.
Delete a template.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Template id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "delete_template",
"arguments": {
"id": "..."
}
}
}delete_topiccan modifydestructiveDelete a topic you created (built-in topics stay).
Delete a topic you created (built-in topics stay).
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Topic id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "delete_topic",
"arguments": {
"id": "..."
}
}
}delete_webhookcan modifydestructiveDelete a webhook endpoint.
Delete a webhook endpoint.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Webhook endpoint id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "delete_webhook",
"arguments": {
"id": "..."
}
}
}disconnect_integrationcan modifydestructiveDisconnect a tool: its credentials and its list are deleted; the contacts stay with their consent.
Disconnect a tool: its credentials and its list are deleted; the contacts stay with their consent.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Integration id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "disconnect_integration",
"arguments": {
"id": "..."
}
}
}enter_registration_phone_codecan modifydestructiveexternal accessA sole proprietor's registration: the code texted to their mobile after submitting (it lasts 24 hours). The …
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.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Registration id (reg_...) |
code | string | required | The code from the text sent to the sole proprietor's mobile. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "enter_registration_phone_code",
"arguments": {
"id": "...",
"code": "..."
}
}
}export_consentread-onlyThe suppression list, or the full consent ledger with opt-in proof, as CSV text.
The suppression list, or the full consent ledger with opt-in proof, as CSV text.
| Parameter | Type | Description | |
|---|---|---|---|
type | string | optional | suppressions: the opted-out numbers. ledger: every consent record, with proof One of: suppressions, ledger |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "export_consent",
"arguments": {}
}
}export_csvread-onlyExport as CSV text for analysis: messages, deliveries, events, opt_outs, webhook_deliveries, usage, …
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.
| Parameter | Type | Description | |
|---|---|---|---|
kind | string | required | messages, deliveries, events, opt_outs, webhook_deliveries, usage, usage_monthly, audit_log or credit_history |
from | string | optional | ISO date/time or epoch ms (messages, deliveries, events, webhook_deliveries) |
to | string | optional | Inclusive; a bare date means the end of that day (UTC) |
status | string | optional | messages, deliveries One of: queued, sent, delivered, failed, blocked, received |
blocked_reason | string | optional | messages, deliveries: blocked messages with this reason |
direction | string | optional | messages One of: outbound, inbound |
number | string | optional | messages, deliveries: digits matched against either side |
to_number | string | optional | messages, deliveries: exact recipient (E.164). `to`/`from` are the date range here. |
from_number | string | optional | messages, deliveries: exact sender (E.164) |
customer_id | string | optional | messages, deliveries |
failure_code | string | optional | messages, deliveries: failed for this reason (the `failure.code` on a message) One of: carrier_filtered, unreachable, invalid_number, opted_out, campaign_mismatch, content_blocked, screen_unavailable, rate_limited … |
batch | string | optional | messages, deliveries: batch id (bc_...) |
q | string | optional | messages: body/failure text; events: id/payload text |
type | string | optional | events, webhook_deliveries |
endpoint_id | string | optional | webhook_deliveries (default: all endpoints) |
ok | boolean | optional | webhook_deliveries |
months | integer | optional | usage: daily rows for the last N months |
action | string | optional | audit_log: one action, or a group prefix with a trailing dot (team.) |
actor | string | optional | audit_log: actor id or part of the actor email |
target_type | string | optional | audit_log |
created_after | string | optional | audit_log: same as on GET /audit-logs (from is accepted too) |
created_before | string | optional | audit_log: same as on GET /audit-logs (to is accepted too) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "export_csv",
"arguments": {
"kind": "..."
}
}
}export_numbersread-onlyYour numbers as CSV text.
Your numbers as CSV text.
| Parameter | Type | Description | |
|---|---|---|---|
tag | string | optional | Only numbers with this tag |
pool | string | optional | Pool id |
mode | string | optional | test for sandbox numbers, live for real ones One of: test, live |
q | string | optional | Matches digits of the number or its label |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "export_numbers",
"arguments": {}
}
}fallback_verificationcan modifydestructiveexternal accessThe text did not arrive: email a new code for the same pending verification (one id, one charge). The emailed …
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.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Verification id (ver_...) |
email | string | required | The address to email the code to |
channel | string | optional | The channel to fall back to. Only `email` today. One of: email |
user_ip | string | optional | Optional. Your end user's IP address, counted in the same per-IP limit as POST /verify. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "fallback_verification",
"arguments": {
"id": "...",
"email": "..."
}
}
}forget_identitycan modifydestructivePrivacy erasure: forget the phone number linked to a user_id, so its tracked events stop reaching automations.
Privacy erasure: forget the phone number linked to a user_id, so its tracked events stop reaching automations.
| Parameter | Type | Description | |
|---|---|---|---|
user_id | string | required | Your user id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "forget_identity",
"arguments": {
"user_id": "..."
}
}
}get_automationread-onlyRetrieve an automation with its trigger and steps.
Retrieve an automation with its trigger and steps.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Automation id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_automation",
"arguments": {
"id": "..."
}
}
}get_automation_runread-onlyRetrieve one run with its step-by-step timeline.
Retrieve one run with its step-by-step timeline.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Automation id |
run_id | string | required | Run id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_automation_run",
"arguments": {
"id": "...",
"run_id": "..."
}
}
}get_balanceread-onlyPrepaid credit balance and auto-recharge setting.
Prepaid credit balance and auto-recharge setting.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_balance",
"arguments": {}
}
}get_batchread-onlyRetrieve a batch with its progress counts.
Retrieve a batch with its progress counts.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Batch id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_batch",
"arguments": {
"id": "..."
}
}
}get_batch_resultsread-onlyResults of a batch: delivered, failed, pending, replies, opt-outs (stops), spend, and failures grouped by …
Results of a batch: delivered, failed, pending, replies, opt-outs (stops), spend, and failures grouped by reason.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Batch id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_batch_results",
"arguments": {
"id": "..."
}
}
}get_consentread-onlyWhether a number is opted in or out, per registration, with its full consent history and proof.
Whether a number is opted in or out, per registration, with its full consent history and proof.
| Parameter | Type | Description | |
|---|---|---|---|
phone | string | required | E.164 number |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_consent",
"arguments": {
"phone": "..."
}
}
}get_contactread-onlyRetrieve a contact.
Retrieve a contact.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Contact id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_contact",
"arguments": {
"id": "..."
}
}
}get_contact_topicsread-onlyA contact's subscription to each topic.
A contact's subscription to each topic.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Contact id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_contact_topics",
"arguments": {
"id": "..."
}
}
}get_customerread-onlyRetrieve a customer.
Retrieve a customer.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Customer id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_customer",
"arguments": {
"id": "..."
}
}
}get_customer_usageread-onlyA customer's messages, verifications and spend for a period.
A customer's messages, verifications and spend for a period.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Customer id |
start | string | optional | Default: first day of this month |
end | string | optional | Default: today |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_customer_usage",
"arguments": {
"id": "..."
}
}
}get_deliverabilityread-onlyDelivery rates by day, destination carrier, or sending number.
Delivery rates by day, destination carrier, or sending number.
| Parameter | Type | Description | |
|---|---|---|---|
group_by | string | optional | What to group the rates by One of: day, carrier, number |
start_date | string | optional | YYYY-MM-DD |
end_date | string | optional | YYYY-MM-DD |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_deliverability",
"arguments": {}
}
}get_integrationread-onlyOne connected tool and its last sync.
One connected tool and its last sync.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Integration id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_integration",
"arguments": {
"id": "..."
}
}
}get_integration_eventsread-onlyConfirm the events behind automations: for a Mixpanel integration, each mapped event with its Mixpanel source …
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.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Integration id |
project_events | boolean | optional | Also list the Mixpanel project's event names with their 7-day volume. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_integration_events",
"arguments": {
"id": "..."
}
}
}get_link_domainread-onlyOne short-link domain, with the DNS records it needs.
One short-link domain, with the DNS records it needs.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Link domain id (ld_...) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_link_domain",
"arguments": {
"id": "..."
}
}
}get_listread-onlyRetrieve a list and its contact count.
Retrieve a list and its contact count.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | List id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_list",
"arguments": {
"id": "..."
}
}
}get_messageread-onlyRetrieve a message by its msg_... id, with its delivery timeline.
Retrieve a message by its msg_... id, with its delivery timeline.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Message id (msg_...) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_message",
"arguments": {
"id": "..."
}
}
}get_numberread-onlyRetrieve one of your numbers: status, sender registration, tags, pools, customer.
Retrieve one of your numbers: status, sender registration, tags, pools, customer.
| Parameter | Type | Description | |
|---|---|---|---|
phone_number | string | required | E.164 number you own |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_number",
"arguments": {
"phone_number": "..."
}
}
}get_number_poolread-onlyRetrieve a sender pool and its numbers.
Retrieve a sender pool and its numbers.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Pool id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_number_pool",
"arguments": {
"id": "..."
}
}
}get_registrationread-onlyA registration with its checks, status, and linked numbers.
A registration with its checks, status, and linked numbers.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Registration id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_registration",
"arguments": {
"id": "..."
}
}
}get_scheduleread-onlyRetrieve a recurring schedule with its recent occurrences.
Retrieve a recurring schedule with its recent occurrences.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Schedule id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_schedule",
"arguments": {
"id": "..."
}
}
}get_scheduled_messageread-onlyRetrieve a pending scheduled message.
Retrieve a pending scheduled message.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Scheduled message id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_scheduled_message",
"arguments": {
"id": "..."
}
}
}get_segmentread-onlyRetrieve a segment and its rules.
Retrieve a segment and its rules.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Segment id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_segment",
"arguments": {
"id": "..."
}
}
}get_spend_limitread-onlyThe monthly spend limit and this month's estimated spend.
The monthly spend limit and this month's estimated spend.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_spend_limit",
"arguments": {}
}
}get_templateread-onlyRetrieve a template.
Retrieve a template.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Template id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_template",
"arguments": {
"id": "..."
}
}
}get_toll_free_verificationread-onlyA toll-free verification: status, numbers, the form, what is missing (problems), and the carriers' reason …
A toll-free verification: status, numbers, the form, what is missing (problems), and the carriers' reason when it was rejected.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Toll-free verification id (tfv_...) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_toll_free_verification",
"arguments": {
"id": "..."
}
}
}get_topicread-onlyRetrieve a topic.
Retrieve a topic.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Topic id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_topic",
"arguments": {
"id": "..."
}
}
}get_usageread-onlyUsage by month, today's counters, and plan limits.
Usage by month, today's counters, and plan limits.
| Parameter | Type | Description | |
|---|---|---|---|
months | number | optional | How many months back (default 3) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_usage",
"arguments": {}
}
}get_verificationread-onlyRetrieve a verification by id: its status and attempts (never the code).
Retrieve a verification by id: its status and attempts (never the code).
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Verification id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_verification",
"arguments": {
"id": "..."
}
}
}get_webhookread-onlyRetrieve a webhook endpoint.
Retrieve a webhook endpoint.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Webhook endpoint id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "get_webhook",
"arguments": {
"id": "..."
}
}
}import_contactscan modifydestructiveCreate or update up to 500 contacts per call, matched by phone_number. Attributes go in fields (up to 20 …
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.
| Parameter | Type | Description | |
|---|---|---|---|
contacts | object[] | required | Contacts to create or update, up to 500 per call |
campaign_id | string | optional | Applies to every opt_in row that does not name its own campaign_id |
dry_run | boolean | optional | true returns what would change and writes nothing |
check_line_types | boolean | optional | dry_run only. Looks up line types to count landlines; live lookups are paid, so only the first 500 numbers are checked. |
import_id | string | optional | From a previous response, to group several requests as one import. |
name | string | optional | A label for the import (first request only). |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "import_contacts",
"arguments": {
"contacts": []
}
}
}import_opt_outscan modifydestructiveBring a suppression list over from another provider or tool (up to 500 numbers per call), so people who opted …
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.
| Parameter | Type | Description | |
|---|---|---|---|
phone_numbers | string[] | required | Opted-out numbers in E.164, up to 500 per call |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "import_opt_outs",
"arguments": {
"phone_numbers": []
}
}
}link_number_to_registrationcan modifydestructiveAttach a number to an approved 10DLC registration so it can send that registration's traffic.
Attach a number to an approved 10DLC registration so it can send that registration's traffic.
| Parameter | Type | Description | |
|---|---|---|---|
phone_number | string | required | E.164 number you own |
registration_id | string | required | The approved registration to attach the number to (reg_...) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "link_number_to_registration",
"arguments": {
"phone_number": "...",
"registration_id": "..."
}
}
}list_api_keysread-onlyList the active API keys of this mode (never the secrets).
List the active API keys of this mode (never the secrets).
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_api_keys",
"arguments": {}
}
}list_audit_logsread-onlyWho changed what on the account (keys, team, webhooks, spend limit, numbers, consent, settings), newest first.
Who changed what on the account (keys, team, webhooks, spend limit, numbers, consent, settings), newest first.
| Parameter | Type | Description | |
|---|---|---|---|
limit | integer | optional | Max results (default 25, max 100) |
cursor | string | optional | next_cursor from the previous page |
action | string | optional | One action, or a group prefix with a trailing dot (team., api_key.) |
actor | string | optional | Actor id (exact) or part of the actor email (case-insensitive) |
target_type | string | optional | Target type, e.g. api_key, member, invite, webhook, number, phone |
created_after | string | optional | Entries at or after this time (ISO 8601) |
created_before | string | optional | Entries at or before this time (ISO 8601); a bare date means the end of that day (UTC) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_audit_logs",
"arguments": {}
}
}list_automation_runsread-onlyList an automation's runs, newest first.
List an automation's runs, newest first.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Automation id |
limit | number | optional | Max results (default 25, max 100) |
cursor | string | optional | next_cursor from the previous page |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_automation_runs",
"arguments": {
"id": "..."
}
}
}list_automationsread-onlyList automations.
List automations.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_automations",
"arguments": {}
}
}list_batch_recipientsread-onlyList a batch's recipients with each one's status.
List a batch's recipients with each one's status.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Batch id |
status | string | optional | Only recipients with this status One of: queued, paused, sent, failed, skipped, canceled |
limit | number | optional | Max results (default 25, max 100) |
cursor | string | optional | next_cursor from the previous page |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_batch_recipients",
"arguments": {
"id": "..."
}
}
}list_batchesread-onlyList batches (broadcasts), newest first.
List batches (broadcasts), newest first.
| Parameter | Type | Description | |
|---|---|---|---|
limit | number | optional | Max results (default 25, max 100) |
cursor | string | optional | next_cursor from the previous page |
status | string | optional | Only batches with this status One of: scheduled, sending, paused, complete, canceled |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_batches",
"arguments": {}
}
}list_contactsread-onlyList contacts, newest first. Filter by tag, segment_id, list_id, exact phone_number, or a free-text q (name, …
List contacts, newest first. Filter by tag, segment_id, list_id, exact phone_number, or a free-text q (name, email, company).
| Parameter | Type | Description | |
|---|---|---|---|
limit | number | optional | Max results (default 25, max 100) |
cursor | string | optional | next_cursor from the previous page |
tag | string | optional | Only contacts with this tag |
phone_number | string | optional | E.164 |
segment_id | string | optional | Only contacts in this segment |
list_id | string | optional | Only contacts in this list |
q | string | optional | Search text |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_contacts",
"arguments": {}
}
}list_conversionsread-onlyThe latest 100 conversions, newest first.
The latest 100 conversions, newest first.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_conversions",
"arguments": {}
}
}list_customersread-onlyList your customers.
List your customers.
| Parameter | Type | Description | |
|---|---|---|---|
limit | integer | optional | Max results (default 25, max 100) |
cursor | string | optional | next_cursor from the previous page |
external_id | string | optional | Find the customer with this external_id (0 or 1 results) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_customers",
"arguments": {}
}
}list_eventsread-onlyList recent events (message.sent/delivered/failed/received, number.purchased/released, ...), newest first.
List recent events (message.sent/delivered/failed/received, number.purchased/released, ...), newest first.
| Parameter | Type | Description | |
|---|---|---|---|
limit | number | optional | Max results (default 25, max 100) |
cursor | string | optional | next_cursor from the previous page |
type | string | optional | Only events of this type, like message.delivered |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_events",
"arguments": {}
}
}list_integrationsread-onlyThe connected tools: status, settings, last sync (found, added, opted out), and their list. No credentials.
The connected tools: status, settings, last sync (found, added, opted out), and their list. No credentials.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_integrations",
"arguments": {}
}
}list_link_domainsread-onlyYour short-link domains and their status (pending_dns, dns_verified, active). Optional: a message sent with …
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.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_link_domains",
"arguments": {}
}
}list_linksread-onlyEvery tracked destination with its texts, clicks, conversions and value. The answer to "which link worked?".
Every tracked destination with its texts, clicks, conversions and value. The answer to "which link worked?".
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_links",
"arguments": {}
}
}list_list_contactsread-onlyPage through a list's contacts, most recently added first.
Page through a list's contacts, most recently added first.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | List id |
limit | integer | optional | Max results (default 25, max 100) |
cursor | string | optional | next_cursor from the previous page |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_list_contacts",
"arguments": {
"id": "..."
}
}
}list_listsread-onlyList contact lists with their contact counts.
List contact lists with their contact counts.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_lists",
"arguments": {}
}
}list_messagesread-onlyList your messages, newest first. Filter by number, direction, status, failure reason, date, batch schedule …
List your messages, newest first. Filter by number, direction, status, failure reason, date, batch schedule or customer.
| Parameter | Type | Description | |
|---|---|---|---|
limit | number | optional | Max results (default 25, max 100) |
cursor | string | optional | next_cursor from the previous page |
number | string | optional | Filter to messages to or from this number |
to | string | optional | Exact destination number (E.164) |
from | string | optional | Exact sending number (E.164) |
status | string | optional | Only messages with this status One of: queued, sent, delivered, failed, blocked, received |
blocked_reason | string | optional | Blocked messages with this reason. Implies status=blocked. One of: account_closed, account_suspended, account_paused, opted_out, destination_not_allowed, voip_number, toll_free_destination, toll_free_unverified … |
failure_code | string | optional | Filter to messages that failed for this reason (the `failure.code` on a message) One of: carrier_filtered, unreachable, invalid_number, opted_out, campaign_mismatch, content_blocked, screen_unavailable, rate_limited … |
direction | string | optional | outbound (sent) or inbound (received) One of: outbound, inbound |
created_after | string | optional | Inclusive. ISO timestamp or epoch ms. |
created_before | string | optional | Exclusive. ISO timestamp or epoch ms. |
customer_id | string | optional | Filter to one customer's messages |
schedule_id | string | optional | Filter to the occurrences of one recurring schedule (sch_...) |
tag | string | optional | Filter to messages sent with this tag |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_messages",
"arguments": {}
}
}list_number_poolsread-onlyList sender pools.
List sender pools.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_number_pools",
"arguments": {}
}
}list_number_requestsread-onlyOpen short-code and toll-free requests.
Open short-code and toll-free requests.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_number_requests",
"arguments": {}
}
}list_numbersread-onlyList the phone numbers on your account.
List the phone numbers on your account.
| Parameter | Type | Description | |
|---|---|---|---|
customer_id | string | optional | Only this customer's numbers |
tag | string | optional | Only numbers with this tag |
pool | string | optional | Pool id |
mode | string | optional | test for sandbox numbers, live for real ones One of: test, live |
q | string | optional | Matches digits of the number or its label |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_numbers",
"arguments": {}
}
}list_opt_outsread-onlyList opted-out numbers (the suppression list).
List opted-out numbers (the suppression list).
| Parameter | Type | Description | |
|---|---|---|---|
limit | number | optional | Max results (default 25, max 100) |
cursor | string | optional | next_cursor from the previous page |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_opt_outs",
"arguments": {}
}
}list_registration_submissionsread-onlyThe filed copies of a 10DLC registration, newest first.
The filed copies of a 10DLC registration, newest first.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Registration id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_registration_submissions",
"arguments": {
"id": "..."
}
}
}list_registrationsread-onlyList 10DLC brand and campaign registrations and their status. Marketing from a local number needs an approved …
List 10DLC brand and campaign registrations and their status. Marketing from a local number needs an approved one.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_registrations",
"arguments": {}
}
}list_scheduled_messagesread-onlyList single messages scheduled for later and not yet sent.
List single messages scheduled for later and not yet sent.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_scheduled_messages",
"arguments": {}
}
}list_schedulesread-onlyList recurring schedules.
List recurring schedules.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_schedules",
"arguments": {}
}
}list_segmentsread-onlyList saved segments.
List saved segments.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_segments",
"arguments": {}
}
}list_templatesread-onlyList message templates.
List message templates.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_templates",
"arguments": {}
}
}list_toll_free_verificationsread-onlyList toll-free verifications and their status (draft, in_review with us, submitted to the carriers, verified, …
List toll-free verifications and their status (draft, in_review with us, submitted to the carriers, verified, rejected). A toll-free number texts the public only once verified.
| Parameter | Type | Description | |
|---|---|---|---|
status | string | optional | Only verifications with this status One of: draft, in_review, submitted, verified, rejected |
limit | integer | optional | Max results (default 25, max 100) |
cursor | string | optional | next_cursor from the previous page |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_toll_free_verifications",
"arguments": {}
}
}list_topicsread-onlyList subscription topics.
List subscription topics.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_topics",
"arguments": {}
}
}list_webhook_deliveriesread-onlyDelivery attempts to your webhook endpoints, with response status codes.
Delivery attempts to your webhook endpoints, with response status codes.
| Parameter | Type | Description | |
|---|---|---|---|
endpoint_id | string | optional | One endpoint (we_...), or status_callback for the attempts to send messages' own status callbacks. |
event_id | string | optional | Every attempt for one event |
limit | number | optional | Max results (default 25, max 100) |
cursor | string | optional | next_cursor from the previous page |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_webhook_deliveries",
"arguments": {}
}
}list_webhooksread-onlyList webhook endpoints.
List webhook endpoints.
Takes no parameters.
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "list_webhooks",
"arguments": {}
}
}lookup_phoneread-onlyexternal accessLook up line type (mobile, landline, VoIP) and carrier for any US/Canada number.
Look up line type (mobile, landline, VoIP) and carrier for any US/Canada number.
| Parameter | Type | Description | |
|---|---|---|---|
phone | string | required | E.164 number |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "lookup_phone",
"arguments": {
"phone": "..."
}
}
}pause_automationcan modifydestructivePause an automation: no new runs start, and runs in progress wait where they are until it is activated again.
Pause an automation: no new runs start, and runs in progress wait where they are until it is activated again.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Automation id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "pause_automation",
"arguments": {
"id": "..."
}
}
}pause_batchcan modifydestructivePause a sending or scheduled batch.
Pause a sending or scheduled batch.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Batch id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "pause_batch",
"arguments": {
"id": "..."
}
}
}plan_campaignread-onlyEvery input a send needs, as questions to ask the person, with this account's options for each. kind …
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, right away or optimal user time, 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 …
| Parameter | Type | Description | |
|---|---|---|---|
kind | string | optional | automation (texts started by an event) or broadcast (one send to an audience). One of: automation, broadcast |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "plan_campaign",
"arguments": {}
}
}plan_importread-onlyFind out where an audience is and the ways to bring it in. Without source: questions to ask the person (where …
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 …
| Parameter | Type | Description | |
|---|---|---|---|
source | string | optional | Where the people are, in your words. Omit to get the questions first. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "plan_import",
"arguments": {}
}
}plan_taskread-onlyThe questions behind anything a person does here, with this account's options for each: send a text, buy or …
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 …
| Parameter | Type | Description | |
|---|---|---|---|
task | string | optional | A task key (buy_number, register_10dlc, ...) or the person's own words ("buy a number"). Omit to list the tasks. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "plan_task",
"arguments": {}
}
}prefill_registrationcan modifydestructiveexternal accessSuggest a 10DLC registration from a business website: business and legal name, use case, description, opt-in, …
Suggest a 10DLC registration from a business website: business and legal name, use case, description, opt-in, privacy and terms pages (ranked candidates), support email and draft example texts. Reads public pages only and changes nothing. The suggestions are guesses for the person to confirm.
| Parameter | Type | Description | |
|---|---|---|---|
website | string | required | The business's website to read. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "prefill_registration",
"arguments": {
"website": "..."
}
}
}preview_automationread-onlySee an automation's texts exactly as they would go out, without sending: works on drafts. Pass sample event …
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, merge fields that would come out empty, and, for an optimal-user-time step with `to`, next_send: when it would go for that person and why.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Automation id |
properties | object | optional | Sample event properties for merge fields, e.g. {"plan": "pro"} |
to | string | optional | E.164. Fills contact merge fields and shows when an optimal-user-time text would go for this person |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "preview_automation",
"arguments": {
"id": "..."
}
}
}preview_segmentread-onlyCount the contacts a segment matches right now and how many a broadcast would reach (opted-out contacts …
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.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Segment id |
topic_id | string | optional | Count only contacts subscribed to this topic |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "preview_segment",
"arguments": {
"id": "..."
}
}
}purchase_numbercan modifydestructiveexternal accessBuy a phone number for your account (free sandbox numbers with test keys). Live numbers are billed monthly.
Buy a phone number for your account (free sandbox numbers with test keys). Live numbers are billed monthly.
| Parameter | Type | Description | |
|---|---|---|---|
phone_number | string | required | The number to buy, in E.164 |
customer_id | string | optional | Optional: assign the number to one of your customers |
registration_id | string | optional | Optional (live numbers): the registration this number should send for. Without it the number follows your account's registration. |
idempotency_key | string | optional | Optional. Retries are already safe: the same call with the same inputs within 10 minutes is done once and answers with the first result. Pass your own key to dedupe across a longer gap, or a new one to repeat an identical call on purpose. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "purchase_number",
"arguments": {
"phone_number": "..."
}
}
}query_audiencecan modifydestructiveCount a cohort without saving anything (nothing appears in the console): run up to 10 segment rules now and …
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, …
| Parameter | Type | Description | |
|---|---|---|---|
match | string | optional | all: a contact must match every rule. any: at least one rule One of: all, any |
rules | object[] | optional | Up to 10 rules that decide who matches |
topic_id | string | optional | Topic id or name: eligible also removes contacts unsubscribed from it |
limit | integer | optional | How many matching contacts to return |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "query_audience",
"arguments": {}
}
}recheck_registrationcan modifydestructiveexternal accessCorrect a registration and run its checks again (draft, checks_failed, ready or rejected). Send any field to …
Correct a registration and run its checks again (draft, checks_failed, ready or rejected). Send any field to change it; after fixing the website, this re-reads it. Returns the new status and findings.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Registration id (reg_...) |
business_name | string | required | The name customers know the business by, as the texts will name it. |
website | string | required | The business's own website. Reviewers visit it to confirm the business is real. |
use_case | string | required | What the texts are for. marketing and mixed need an opt-in for each person. One of: 2fa, account_notification, customer_care, delivery_notification, fraud_alert, higher_education, marketing, mixed … |
opt_in_url | string | optional | Page where people enter their number |
opt_in_screenshot_url | string | optional | People opt in inside an app: a public link to an image of that screen. Checked in place of a phone field and filed with the opt-in. null clears it. |
privacy_url | string | optional | Discovered from homepage links when omitted |
terms_url | string | optional | Discovered from homepage links when omitted |
support_email | string | optional | Used in the generated HELP reply |
sample_messages | string[] | optional | Real examples of the texts you will send, as a recipient would get them (no template variables). Carriers compare them with your traffic. Each must name your business; marketing and mixed use cases need opt-out wording in at least one. More than 5, or one … |
starter_messages | string[] | optional | Draft examples suggested for this business (fields.sample_messages from POST /registrations/prefill). Shown instead of the template starter drafts; samples_source stays starter and they are never filed until you edit or confirm them. Drafts that would not … |
samples_confirmed | boolean | optional | true = the starter drafts are right as they are; they become your examples. Ignored when sample_messages is sent. |
description | string | optional | What you send and to whom (40 to 500 characters). Omit or null to file the generated one. |
opt_in_flow | string | optional | How people opt in, in your own words. It leads the filed opt-in account; the opt-in page, the disclosure and the START keyword are added after it. Omit or null to file the standard sentence. |
stop_reply | string | optional | Your wording of the confirmation sent when someone opts out. It must name your business, say they are unsubscribed, and carry no link; anything else is a 400 naming what is missing. Omit or null for the standard wording in your business name. Filed with the … |
help_reply | string | optional | Your wording of the HELP reply. It must name your business, give a way to reach you (email, phone or web page) and keep the STOP instruction. Omit or null for the standard wording. |
includes_links | boolean | optional | Your messages include web links. Also true whenever an example contains one. |
includes_phone_numbers | boolean | optional | Your messages include phone numbers. Also true whenever an example contains one. |
age_gated | boolean | optional | Your messages are for adults only (alcohol, cannabis, gambling). |
direct_lending | boolean | optional | Your messages are about loans you make yourself. |
brand | object | optional | The business as the carriers register it. street must be a street address, not a P.O. box; state a 2-letter US state or territory code; postal_code a 5-digit ZIP (optionally +4). Anything else is refused with 400 naming the field. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "recheck_registration",
"arguments": {
"id": "...",
"business_name": "...",
"website": "...",
"use_case": "2fa"
}
}
}recommend_messageread-onlyWhich text should we send? Ranked SMS copy for a goal (abandoned_cart, welcome, winback, failed_payment, …
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 …
| Parameter | Type | Description | |
|---|---|---|---|
industry | string | required | The sender's industry One of: apparel, home_goods, food_beverage, restaurant, beauty, health_wellness, cannabis, hospitality … |
company_type | string | required | Kind of business One of: ecommerce, subscription_ecommerce, subscription_app, consumer_app, restaurant, hospitality, retail, marketplace … |
goal | string | optional | The message type to write, or `any` to compare the types that fit `audience` One of: any, abandoned_cart, abandoned_browse, welcome, winback, failed_payment, trial, promo … |
audience | string | optional | Who gets it, in words, e.g. "opened the paywall and left" |
brand | string | required | Business name as customers know it |
product | string | required | What is being sold, as the customer would say it, e.g. "your second number" |
offer | string | optional | Optional, e.g. "50% off your first month". Without one no candidate has an offer |
code | string | optional | Optional promo code |
deadline | string | optional | Optional, e.g. "tonight" |
link | string | optional | URL or merge field; default {{link}} |
first_name | boolean | optional | Your contacts have first names, so candidates may use {{first_name}} |
first_message | boolean | optional | The first text these people get from the number: the brand and opt-out line are added and counted |
candidates | string | optional | Your own drafts to score: a JSON array of up to 10 strings |
limit | integer | optional | How many messages to return (default 5, max 20) |
use_history | boolean | optional | false ranks on the case studies only |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "recommend_message",
"arguments": {
"industry": "apparel",
"company_type": "ecommerce",
"brand": "...",
"product": "..."
}
}
}record_conversioncan modifydestructiveReport a sale or sign-up from someone who came through a tracked link. click_id is the tk value on the …
Report a sale or sign-up from someone who came through a tracked link. click_id is the tk value on the landing page's URL; value_cents is what it was worth; external_id (an order id) stops a retry counting twice.
| Parameter | Type | Description | |
|---|---|---|---|
click_id | string | required | The `tk` value on the landing page URL. |
value_cents | integer | optional | Optional. What it was worth, in US cents. |
name | string | optional | Optional. What happened, like purchase. |
external_id | string | optional | Optional. Your id for it. The same id twice counts once and returns the first with 200. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "record_conversion",
"arguments": {
"click_id": "..."
}
}
}redact_messagecan modifydestructiveEmpty a finished message's text and media everywhere it is kept, keeping its status, price and timeline …
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.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Message id (msg_...) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "redact_message",
"arguments": {
"id": "..."
}
}
}release_numbercan modifydestructiveexternal accessRelease a number you own. It cannot be got back.
Release a number you own. It cannot be got back.
| Parameter | Type | Description | |
|---|---|---|---|
phone_number | string | required | E.164 number you own |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "release_number",
"arguments": {
"phone_number": "..."
}
}
}remove_from_listcan modifydestructiveRemove contacts from a list (they stay contacts).
Remove contacts from a list (they stay contacts).
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | List id |
contact_ids | string[] | optional | Contact ids |
phone_numbers | string[] | optional | Phone numbers in E.164, of existing contacts |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "remove_from_list",
"arguments": {
"id": "..."
}
}
}replay_eventcan modifydestructiveexternal accessSend an event again to one webhook endpoint (after fixing the receiver).
Send an event again to one webhook endpoint (after fixing the receiver).
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Event id |
endpoint_id | string | required | The webhook endpoint to send it to (we_...) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "replay_event",
"arguments": {
"id": "...",
"endpoint_id": "..."
}
}
}replay_failed_webhookscan modifydestructiveexternal accessRe-send every event that failed to reach a webhook endpoint in a window (default the last 24 hours, up to 7 …
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.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Webhook endpoint id |
since | string | optional | ISO date or epoch milliseconds. Default: 24 hours before `until`. |
until | string | optional | ISO date or epoch milliseconds. Default: now. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "replay_failed_webhooks",
"arguments": {
"id": "..."
}
}
}request_short_codecan modifydestructiveAsk our team for a short code (or a toll-free number they set up). Provisions nothing by itself; carriers …
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.
| Parameter | Type | Description | |
|---|---|---|---|
type | string | required | short_code, or toll_free for a number our team sets up One of: short_code, toll_free |
business_name | string | required | The business the number is for |
monthly_volume | string | required | Expected texts a month One of: under_1k, 1k_10k, 10k_100k, over_100k |
use_case | string | required | What you will send, in a sentence or two. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "request_short_code",
"arguments": {
"type": "short_code",
"business_name": "...",
"monthly_volume": "under_1k",
"use_case": "..."
}
}
}resend_registration_phone_codecan modifydestructiveexternal accessText a new code to a sole proprietor's mobile for their registration. The old code stops working. At most 5 …
Text a new code to a sole proprietor's mobile for their registration. The old code stops working. At most 5 codes per submission, one a minute.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Registration id (reg_...) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "resend_registration_phone_code",
"arguments": {
"id": "..."
}
}
}resume_batchcan modifydestructiveexternal accessResume a paused batch.
Resume a paused batch.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Batch id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "resume_batch",
"arguments": {
"id": "..."
}
}
}retry_batchcan modifydestructiveexternal accessRetry a batch's failed recipients.
Retry a batch's failed recipients.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Batch id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "retry_batch",
"arguments": {
"id": "..."
}
}
}revoke_api_keycan modifydestructiveRevoke an API key of this mode. Immediate and permanent: anything using it stops working.
Revoke an API key of this mode. Immediate and permanent: anything using it stops working.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | API key id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "revoke_api_key",
"arguments": {
"id": "..."
}
}
}rotate_webhook_secretcan modifydestructiveReplace a webhook endpoint's signing secret (returned once). expire_previous_in keeps the old one signing for …
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.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Webhook endpoint id |
expire_previous_in | integer | optional | Seconds the old secret keeps signing alongside the new one. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "rotate_webhook_secret",
"arguments": {
"id": "..."
}
}
}search_available_numbersread-onlySearch purchasable numbers by area code (default 415).
Search purchasable numbers by area code (default 415).
| Parameter | Type | Description | |
|---|---|---|---|
area_code | string | optional | Three-digit area code (default 415) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "search_available_numbers",
"arguments": {}
}
}send_batchcan modifydestructiveexternal accessSend one message to many people (a broadcast or campaign): pick recipients by segment_id, tags, contact_ids, …
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. scheduled_at sends at one instant; send_at_local (like 2026-11-10T17:00) sends at that time on each person's own clock.no_opt_in (recipients the send will …
| Parameter | Type | Description | |
|---|---|---|---|
from | string | optional | One of your numbers, to pin the batch to it. Leave it out and TextKit picks a number approved for `category` (marketing unless you say otherwise), the same one per recipient. Nothing approved is a 400. |
body | string | required | The message text. Merge tags fill per recipient |
name | string | optional | A name for the broadcast |
recipients | object[] | optional | Explicit recipients, up to 10,000 |
tags | string[] | optional | Send to contacts carrying any of these tags (instead of recipients). |
contact_ids | string[] | optional | Send to these contacts, by id |
segment_id | string | optional | Send to the contacts in this saved segment, evaluated when the batch is created (instead of recipients). |
list_id | string | optional | Send to the contacts in this list, as it is when the batch is created (instead of recipients). |
category | string | optional | Optional. It can make the batch stricter (`marketing`), never looser: the sending number's registration and the wording decide ([which messages are marketing](/docs/compliance-checks#which-messages-are-marketing)). From a number with no registration, a batch … One of: marketing, transactional, otp |
quiet_hours | string | optional | Optional. What to do with a message in the recipient's quiet hours: `block` refuses it (403 quiet_hours), `defer` holds it until their next 9:00am. Omitted: each recipient in quiet hours is held until their 9:00am. One of: block, defer |
topic_id | string | optional | Subscription topic. Recipients unsubscribed from it are removed at validation (`topic_unsubscribed`) and skipped at send time, like opt-outs. Omit to apply opt-outs only. |
shorten_links | boolean | optional | Optional. Rewrite every http(s) link to a tracked short link, per recipient, when each message is sent. Clicks show in GET /batches/{id}/results. |
scheduled_at | string | optional | Future ISO timestamp or epoch ms, up to 30 days out. |
send_at_local | string | optional | Instead of `scheduled_at`: a date and time with no time zone, up to 30 days out, sent at that time in each recipient's own zone, read from the area code. Refused if it has passed for any recipient. Quiet hours still hold a time outside the window. |
dry_run | boolean | optional | Validate only: returns a BatchValidation and sends nothing. |
check_line_types | boolean | optional | Reject landlines (first 500 unique numbers are checked). |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "send_batch",
"arguments": {
"body": "..."
}
}
}send_messagecan modifydestructiveexternal accessSend one SMS from one of your numbers. Set category "marketing" for promotions (the opt-in check applies) and …
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 (narrower in some states) in the recipient's local time a marketing message is refused and anything else is held until 9am, 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 …
| Parameter | Type | Description | |
|---|---|---|---|
to | string | required | Recipient's number in E.164 |
from | string | optional | One of your numbers, or a sender pool id (pool_...): TextKit picks a pool member, the same one for each recipient every time. Optional when the account has exactly one number for the key's mode. |
body | string | required | The message text |
customer_id | string | optional | Optional. Attribute to one of your customers. Defaults to the customer the from-number is assigned to; a number assigned to another customer is rejected (400). |
scheduled_at | string | optional | Optional. Future ISO timestamp (or epoch ms), up to 30 days out. The message is queued and the response is a scheduled_message object instead of a message. A marketing message scheduled into the recipient's quiet hours is refused now (403 quiet_hours) or, … |
category | string | optional | Optional. It can make a message stricter (`marketing`), never looser: what a message is comes from the sending number's registration and its wording ([which messages are marketing](/docs/compliance-checks#which-messages-are-marketing)). A message outside its … One of: marketing, transactional, otp |
quiet_hours | string | optional | Optional. What to do with a message in the recipient's quiet hours: `block` refuses it (403 quiet_hours), `defer` holds it until their next 9:00am. Omitted: the account default (a single marketing send is refused; every other message is held). One-time codes … One of: block, defer |
shorten_links | boolean | optional | Optional. Rewrite every http(s) link in `body` to a short link with clicks tracked (`links` on the message, `message.link_clicked` events): on <your business>.txtkto.com once your business is verified, txtkto.com before that, or your own link domain when you … |
tags | string[] | optional | Optional. Your own labels, up to 10 (letters, digits, space _ . : -; up to 32 characters each; lowercased), for example a campaign or a flow. Stored on the message, sent on its webhook events, and reported by GET /v1/deliverability?group_by=tag. Filter with … |
consent | object | optional | Optional. How the recipient agreed to your messages. A recurring non-marketing message from a number linked to a registration needs an opt-in on file for that registration; when none is, this records it and the message is sent. Never counts for marketing (use … |
media | string[] | optional | Reserved for MMS; currently returns 400 mms_not_enabled. |
status_callback | string | optional | Optional. Also send this message's status events (message.sent, message.delivered, message.failed, message.blocked) to this https URL, signed with your callback secret (POST /v1/webhooks/callback_secret; 400 callback_secret_required until it exists). Logged … |
idempotency_key | string | optional | Optional. Retries are already safe: the same call with the same inputs within 10 minutes is done once and answers with the first result. Pass your own key to dedupe across a longer gap, or a new one to repeat an identical call on purpose. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "send_message",
"arguments": {
"to": "...",
"body": "..."
}
}
}send_verificationcan modifydestructiveexternal accessSend a one-time verification code (OTP) to a phone number by text, or to an email address with channel …
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.
| Parameter | Type | Description | |
|---|---|---|---|
channel | string | optional | How the code goes out. `sms` needs `phone`; `email` needs `email`. One of: sms, email |
phone | string | optional | The number to text the code to (channel `sms`). `to` works too. |
email | string | optional | The address to email the code to (channel `email`). Disposable addresses are refused. |
app_name | string | optional | Your product name, shown in the message |
user_ip | string | optional | Optional. Your end user's IP address, as your server saw it. With it, one person requesting codes for many numbers or addresses is limited (20 an hour per IP on your account, texts and emails together); without it there is no per-IP limit, since requests come … |
from | string | optional | Optional, channel `sms` only: send from a number you own instead of the TextKit pool |
customer_id | string | optional | Optional: attribute the verification to one of your customers |
idempotency_key | string | optional | Optional. Retries are already safe: the same call with the same inputs within 10 minutes is done once and answers with the first result. Pass your own key to dedupe across a longer gap, or a new one to repeat an identical call on purpose. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "send_verification",
"arguments": {}
}
}set_consentcan modifydestructiveRecord an opt-in or opt-out from your own system (CRM, checkout, a form). An opt-in for a marketing …
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).
| Parameter | Type | Description | |
|---|---|---|---|
phone | string | required | E.164 number |
status | string | required | opted_in or opted_out One of: opted_out, opted_in |
note | string | optional | A note kept on the consent record |
campaign_id | string | optional | Only with opted_in: the registration the person opted in to. A marketing send from a number linked to that registration looks for this record. Proof is required when its use case is marketing or mixed (400 otherwise). An opt-out is always account-wide. |
proof | object | optional | Opt-in evidence (Messaging Policy 1.4). Accepted only with status opted_in. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "set_consent",
"arguments": {
"phone": "...",
"status": "opted_out"
}
}
}set_contact_topiccan modifydestructiveSubscribe a contact to a topic, or unsubscribe them (e.g. "promotions" vs "order updates").
Subscribe a contact to a topic, or unsubscribe them (e.g. "promotions" vs "order updates").
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Contact id |
topic | string | required | Topic id (see list_topics) |
subscribed | boolean | required | true subscribes the contact to the topic, false unsubscribes them |
source | string | optional | Where the change came from, e.g. "preference_page". Default "api". |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "set_contact_topic",
"arguments": {
"id": "...",
"topic": "...",
"subscribed": false
}
}
}set_spend_limitcan modifydestructiveSet or remove the monthly spend cap and its alert thresholds. Live sends over the cap are refused.
Set or remove the monthly spend cap and its alert thresholds. Live sends over the cap are refused.
| Parameter | Type | Description | |
|---|---|---|---|
monthly_limit_usd | number | optional | null removes the cap |
alert_thresholds | integer[] | optional | Percentages of the limit to alert at, up to 5, like [50, 80, 100] |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "set_spend_limit",
"arguments": {}
}
}simulate_inboundcan modifydestructiveexternal accessSandbox only: simulate an inbound SMS to one of your test numbers (emits message.received; STOP, START and …
Sandbox only: simulate an inbound SMS to one of your test numbers (emits message.received; STOP, START and HELP act as for real).
| Parameter | Type | Description | |
|---|---|---|---|
to | string | optional | One of your sandbox numbers (never a live number). Optional while the account has one sandbox number. |
from | string | required | Who the simulated text comes from, in E.164 |
body | string | required | The text of the simulated message |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "simulate_inbound",
"arguments": {
"from": "...",
"body": "..."
}
}
}submit_registrationcan modifydestructiveexternal accessFile a ready registration for carrier review, or resubmit one after a rejection. fees_acknowledged: true is …
File a ready registration for carrier review, or resubmit one after a rejection. fees_acknowledged: true is the person's own acceptance of the carrier registration fees (separate from the per-text rate, a campaign billed for at least 3 months, non-refundable even if rejected); it is recorded with the time on the filed copy. The first submit for a business also carries the business attestation, signed by someone authorized to act for it, with the name they give. Both come from the person in this …
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Registration id (reg_...) |
fees_acknowledged | boolean | required | Must be true. Confirms the registration fee terms above. One of: True |
attestation | object | optional | Signed by someone authorized to act for the business, once per business: that they are authorized, that the details match the business's IRS records, and that the business will text only people who agreed to it and will follow the Messaging Policy. Kept as … |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "submit_registration",
"arguments": {
"id": "...",
"fees_acknowledged": true
}
}
}submit_toll_free_verificationcan modifydestructiveexternal accessSend a draft, or a rejected form that was fixed, for review: it becomes in_review, we check it (usually …
Send a draft, or a rejected form that was fixed, for review: it becomes in_review, we check it (usually within minutes) and then file it with the carriers (usually 4 to 5 business days). The first form for a business carries the business attestation, signed by someone authorized to act for it, with the name they give in this conversation. Answers with problems while anything the carriers require is missing. No fee.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Toll-free verification id (tfv_...) |
attestation | object | optional | Signed by someone authorized to act for the business, once per business: that they are authorized, that the details match the business's IRS records, and that the business will text only people who agreed to it and will follow the Messaging Policy. Kept as … |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "submit_toll_free_verification",
"arguments": {
"id": "..."
}
}
}sync_integrationcan modifydestructiveexternal accessSync a connected tool now (up to 6 times an hour) and get what changed.
Sync a connected tool now (up to 6 times an hour) and get what changed.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Integration id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "sync_integration",
"arguments": {
"id": "..."
}
}
}test_automationcan modifydestructiveexternal accessText an automation's messages to your own verified phone or a verified recipient now, skipping waits and …
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.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Automation id |
to | string | required | E.164: your own verified phone or a verified recipient |
from | string | optional | Optional. Send this test from another of your numbers in the same mode (the automation is not changed), e.g. a verified toll-free while its own number is in review. |
properties | object | optional | Sample event properties for merge fields |
steps | string[] | optional | Only these send_sms step ids. Default: all of them |
idempotency_key | string | optional | Optional. Retries are already safe: the same call with the same inputs within 10 minutes is done once and answers with the first result. Pass your own key to dedupe across a longer gap, or a new one to repeat an identical call on purpose. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "test_automation",
"arguments": {
"id": "...",
"to": "..."
}
}
}test_webhookcan modifydestructiveexternal accessSend a signed test.ping to a webhook endpoint and see what it answered.
Send a signed test.ping to a webhook endpoint and see what it answered.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Webhook endpoint id |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "test_webhook",
"arguments": {
"id": "..."
}
}
}track_eventcan modifydestructiveexternal accessRecord something a customer did (e.g. signed_up, cart_abandoned, trial_ending), by user_id and/or phone. It …
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. external_id (their Mixpanel distinct_id, when not user_id) puts the texts it starts on their Mixpanel profile.
| Parameter | Type | Description | |
|---|---|---|---|
event | string | required | Letters, digits, and _ . : - |
user_id | string | optional | Your id for the person. Sent with phone, it links the two, so later events need only user_id |
external_id | string | optional | Optional. The person's id in your analytics tool (their Mixpanel distinct_id; `mixpanel_distinct_id` is accepted too), when it is not user_id. Kept on the event as mixpanel_distinct_id; texts the event starts land on that profile in Mixpanel. Without it, … |
phone | string | optional | The person's number in E.164 |
properties | object | optional | Up to 20 scalar values; usable as merge fields and in conditions. |
idempotency_key | string | optional | Optional. A unique key for this call: a retry with the same key is recorded once. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "track_event",
"arguments": {
"event": "..."
}
}
}update_automationcan modifydestructiveEdit an automation (name, sender or `category`, trigger incl. trigger.cooldown_seconds, or steps). `steps` …
Edit an automation (name, sender or `category`, 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.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Automation id |
name | string | optional | Automation name |
from | string | optional | One of your numbers, to pin the flow to it. Leave it out and TextKit picks a number approved for `category`. A sandbox number makes it a sandbox flow. |
category | string | optional | What it sends: marketing, alerts (transactional) or codes (otp). With no `from`, TextKit picks a number approved for this. Falls back to a built-in topic. One of: marketing, transactional, otp |
topic_id | string | optional | Skip recipients unsubscribed from this topic. |
trigger | object | optional | What starts a run: an event, with optional filters |
steps | object[] | optional | Replaces every step. |
step | object | optional | One of: send_sms {body, from?, send_time?, max_wait_seconds?}; wait {seconds}; wait_for_event {event, timeout_seconds, on_received, on_timeout}; condition {check, on_met, on_not_met}; end. Branches are "continue", "end", or "goto:<id of a later step>". |
if_updated_at | string | optional | The automation's `updated_at` as you read it. If it changed since (another edit), nothing is saved and the answer is 409: read it again and redo the edit on the latest. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "update_automation",
"arguments": {
"id": "..."
}
}
}update_contactcan modifydestructiveUpdate a contact. Only the inputs you pass change; tags and fields replace the whole list or map.
Update a contact. Only the inputs you pass change; tags and fields replace the whole list or map.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Contact id |
phone_number | string | optional | E.164, US or Canada |
name | string | optional | Display name. Null clears it |
tags | string[] | optional | Labels that group contacts |
fields | object | optional | Up to 20 string values |
notes | string | optional | Free-text notes. Null clears them |
first_name | string | optional | First name. Null clears it |
last_name | string | optional | Last name. Null clears it |
email | string | optional | Email address. Null clears it |
company | string | optional | Company name. Null clears it |
state | string | optional | US state or Canadian province, usually a 2-letter code. Null clears it |
source | string | optional | Where the contact came from. Null clears it |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "update_contact",
"arguments": {
"id": "..."
}
}
}update_customercan modifydestructiveRename a customer or change its external_id or metadata.
Rename a customer or change its external_id or metadata.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Customer id |
name | string | optional | The customer's name |
external_id | string | optional | Your id for them; unique per account |
metadata | object | optional | Up to 50 string values |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "update_customer",
"arguments": {
"id": "..."
}
}
}update_integrationcan modifydestructiveexternal accessRename, pause or resume (status), or change an integration's settings or credentials (left-out credentials …
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; exportEvents: false stops sending text events to Mixpanel (on by default); changing only those does not re-test credentials or resync.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Integration id |
name | string | optional | What to call it |
status | string | optional | active, or paused to stop syncing One of: active, paused |
sourceId | string | optional | Mixpanel or Amplitude cohort id; HubSpot list id; Salesforce campaign id; a Shopify customer search |
phoneField | string | optional | The tool's property holding the mobile number |
phoneEvent | string | optional | Mixpanel: an event that carries the number when profiles do not |
phoneEventProperty | string | optional | Mixpanel: that event's property holding the number (default phone) |
exportEvents | boolean | optional | Mixpanel (with a service account): send each text's events onto the person's Mixpanel profile: TextKit Message Sent, Delivered, Failed, Link Clicked, Reply Received and Opted Out, with the message, batch or automation and step ids and names. The person is … |
eventTriggers | object[] | optional | Mixpanel (with a service account): events to turn into TextKit events within about 10 minutes, so automations start, wait and branch on them. Each entry is a TextKit event name and the Mixpanel events that count as it, like { event: "purchase_completed", … |
consentField | string | optional | The tool's property that records SMS consent |
consentEvent | string | optional | Mixpanel / Amplitude: the opt-in event the cohort is built on |
username | string | optional | Mixpanel service account username |
secret | string | optional | Mixpanel service account secret |
apiKey | string | optional | Amplitude API key |
secretKey | string | optional | Amplitude secret key |
accessToken | string | optional | HubSpot private app token, or Shopify Admin API access token |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "update_integration",
"arguments": {
"id": "..."
}
}
}update_listcan modifydestructiveRename a list or change its description.
Rename a list or change its description.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | List id |
name | string | optional | List name |
description | string | optional | What the list is for |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "update_list",
"arguments": {
"id": "..."
}
}
}update_number_poolcan modifydestructiveRename a sender pool or change its numbers.
Rename a sender pool or change its numbers.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Pool id |
name | string | optional | Pool name |
description | string | optional | What the pool is for |
routing | string | optional | How a recipient gets a number. sticky: the same member every time. local: a member in the recipient's area code, else one in their time zone, else any; still the same one each time. One of: sticky, local |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "update_number_pool",
"arguments": {
"id": "..."
}
}
}update_schedulecan modifydestructiveexternal accessPause (active: false) or resume (active: true) a recurring schedule.
Pause (active: false) or resume (active: true) a recurring schedule.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Schedule id |
active | boolean | optional | false pauses, true resumes. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "update_schedule",
"arguments": {
"id": "..."
}
}
}update_segmentcan modifydestructiveRename a segment or replace its rules.
Rename a segment or replace its rules.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Segment id |
name | string | optional | Segment name |
description | string | optional | What the segment is for |
match | string | optional | all: a contact must match every rule. any: at least one rule One of: all, any |
rules | object[] | optional | Up to 10 rules that decide who matches |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "update_segment",
"arguments": {
"id": "..."
}
}
}update_templatecan modifydestructiveRename or edit a template.
Rename or edit a template.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Template id |
name | string | optional | Template name |
body | string | optional | The message text, with merge tags |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "update_template",
"arguments": {
"id": "..."
}
}
}update_toll_free_verificationcan modifydestructiveChange a toll-free verification: send only the fields to change. Allowed while draft, in_review (until it …
Change a toll-free verification: send only the fields to change. Allowed while draft, in_review (until it goes to the carriers) and rejected; after a rejection, fix what it asks for, then submit again.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Toll-free verification id (tfv_...) |
numbers | string[] | optional | Your live toll-free numbers this program texts from, E.164. One per business unless multiple_numbers_reason says why. |
multiple_numbers_reason | string | optional | Why the program needs more than one number (one per store, say). Required with more than one number. |
business_name | string | optional | The legal name, as on the IRS EIN letter, optionally with "d/b/a" and the brand your messages carry. |
ein | string | optional | The EIN (US), matching the legal name; elsewhere the business registration number. |
entity_type | string | optional | The kind of business. One of: PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT, SOLE_PROPRIETOR |
street | string | optional | Street address of the business. |
city | string | optional | City. |
state | string | optional | State or province code. |
postal_code | string | optional | ZIP or postal code. |
country | string | optional | Country of the business. |
contact_first_name | string | optional | First name of the person the carriers can contact about this program. |
contact_last_name | string | optional | Their last name. |
contact_phone | string | optional | A phone number they answer. |
brand_email | string | optional | The business's own email, for its customers: the HELP reply and the hosted opt-in page name it. |
website | string | optional | The business's website. |
use_case | string | optional | What the texts are for. One of: 2fa, account_notification, customer_care, delivery_notification, fraud_alert, higher_education, marketing, mixed … |
use_case_summary | string | optional | What the program sends, to whom and why. At least 40 characters. |
sample_messages | string[] | optional | At least two example messages. |
help_reply | string | optional | The reply to HELP: names the business and how to reach it. Omit to keep ours. |
stop_reply | string | optional | The reply to STOP: names the business and says they are unsubscribed. Omit to keep ours. |
opt_in_description | string | optional | How people opt in, step by step. At least 40 characters. |
opt_in_url | string | optional | The opt-in page. With none of your own we make you a hosted one. |
opt_in_screenshot_url | string | optional | A public image of the step where people enter their number and agree. Needed when the opt-in page itself has no phone field, like a later step of a form or an app. |
monthly_volume | string | optional | How many texts a month this program sends. |
volume_basis | string | optional | existing: what it sends today. projecting: an estimate. One of: existing, projecting |
advertising | string | optional | Whether the messages advertise a product or service. One of: yes, no, unsure |
previous_service | string | optional | Where this traffic ran before. One of: new, short_code, long_number |
previous_content | string | optional | Sample messages from the previous service (not new only). |
previous_numbers | string | optional | The numbers it used (not new only). |
number_published | string | optional | Where people see this number. |
fortune_500 | boolean | optional | The company is in the Fortune 500. |
urls_in_messages | string | optional | Links your messages include, or "None". |
phones_in_messages | string | optional | Phone numbers your messages include, or "None". |
terms_url | string | optional | The terms page, with the SMS program terms. |
privacy_url | string | optional | The privacy policy page. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "update_toll_free_verification",
"arguments": {
"id": "..."
}
}
}update_topiccan modifydestructiveRename or describe a topic.
Rename or describe a topic.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Topic id |
name | string | optional | Topic name |
description | string | optional | What the topic covers |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "update_topic",
"arguments": {
"id": "..."
}
}
}update_webhookcan modifydestructiveexternal accessChange a webhook endpoint: URL, events, or turn it off (active: false).
Change a webhook endpoint: URL, events, or turn it off (active: false).
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Webhook endpoint id |
url | string | optional | The https URL that receives the events |
events | string | string[] | optional | Event types to send, or * for all |
active | boolean | optional | false pauses delivery; pending retries for a paused endpoint are dropped. |
description | string | optional | A note on what the endpoint is for |
numbers | string[] | optional | Replace the number filter; [] or null clears it. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "update_webhook",
"arguments": {
"id": "..."
}
}
}upsert_contactcan modifydestructiveCreate a contact, or update the existing one with the same phone_number.
Create a contact, or update the existing one with the same phone_number.
| Parameter | Type | Description | |
|---|---|---|---|
phone_number | string | required | E.164, US or Canada |
name | string | optional | Display name. Defaults to first + last name. |
tags | string[] | optional | Labels that group contacts |
fields | object | optional | Up to 20 string values (account id, plan, location...), usable in segments and as {{field:key}} merge fields |
notes | string | optional | Free-text notes |
first_name | string | optional | First name |
last_name | string | optional | Last name |
email | string | optional | Email address |
company | string | optional | Company name |
state | string | optional | US state or Canadian province, usually a 2-letter code |
source | string | optional | Where the contact came from. Defaults to "api". |
opt_in | object | optional | Import only (POST /v1/contacts/import). Stored as consent evidence; never lifts an opt-out. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "upsert_contact",
"arguments": {
"phone_number": "..."
}
}
}verify_link_domaincan modifydestructiveCheck a link domain's DNS records now. When both are found it is turned on (active) at once.
Check a link domain's DNS records now. When both are found it is turned on (active) at once.
| Parameter | Type | Description | |
|---|---|---|---|
id | string | required | Link domain id (ld_...) |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "verify_link_domain",
"arguments": {
"id": "..."
}
}
}wait_for_eventsread-onlyWait up to 25 seconds for the next events after a cursor (a reply, a delivery receipt), then return them.
Wait up to 25 seconds for the next events after a cursor (a reply, a delivery receipt), then return them.
| Parameter | Type | Description | |
|---|---|---|---|
cursor | string | optional | The `cursor` of the previous response. Omit on the first call. |
timeout | integer | optional | Seconds to hold the request. |
Example call (required arguments only, placeholder values):
{
"method": "tools/call",
"params": {
"name": "wait_for_events",
"arguments": {}
}
}Prompts 23
import_audienceBring people from anywhere (analytics, CRM, store, email tool, billing, database, spreadsheet, file) into TextKit as tagged contacts and a segment. It asks where they are first if you have not said, …build_automationSet up texts that go out when something happens (a signup, a paywall view, a failed payment): it asks which event starts it, how long after, whether to use optimal user time, what ends it, …send_campaignText an audience: find or import it, draft the message, dry-run it, and send or schedule only after you approve.campaign_reportHow your texts did: delivery, replies, opt-outs and spend per batch, the trend, and who to follow up with.helpEvery TextKit command and what it does. Or describe a task and it picks the right one.balanceCredit balance, this month's usage and the spend limit. Change the spend limit.numbersYour numbers and what each is approved for. Search, buy, release, pool or move numbers.sendSend one text, see recent texts, look up a number, or delete and redact a text.batchText a segment, tag or list: dry run first, then send or schedule. Pause, resume, cancel or retry a batch.scheduleTexts waiting to go out and recurring schedules. Create, change or cancel them.verifySend and check one-time codes, fall back to a call or another channel, look up a verification.registerRegister for 10DLC or verify a toll-free number: filled from your website, checked, then filed when you approve.contactsFind, add, import, tag, update or delete contacts, and manage fixed lists.audienceAsk who did what (replied, clicked, got a batch) and save it as a segment to text.consentWho agreed to texts and who opted out. Record consent, import a STOP list, manage topics.templatesSaved texts with merge fields. Create, change or delete them.automationsTexts that go out when something happens. Build, preview, test, turn on or pause them, and see runs.linksShort links with clicks and conversions, and your own link domain.integrationsConnect Mixpanel, Amplitude, HubSpot, Shopify or Salesforce, sync it, see its events, or disconnect.webhooksWebhook endpoints, deliveries and the event log. Add, test, replay or rotate a secret.customersAccounts you text on behalf of (for platforms): create, change, delete and see their usage.api_keysYour API keys. Create one for an app, or revoke one.reportsDelivery rates and failure reasons, raw exports and the audit log.
Badge
Maintain this server? Put its live status in your README:
[](https://mcp.aianytime.net/s/textkit/)Edit this entry · Report a problem
More in Work & productivity
Checks record what a server answered, not whether it is safe. A listing is not a security audit; read a server's source and permissions before you connect it. Add a server · JSON · llms.txt · llms-full.txt
Browse: Agents, IDEs & developer tools · Search & discovery · Knowledge, memory & context · Media & generation · Security · Finance & markets · Marketing, content & social · Cloud, ops & data · Commerce, travel & logistics · Work & productivity · No account needed · Local servers