TextKit
SMS for developers. Send and receive texts with a simple API, built for developers and AI agents. US and Canada, free to start.
This listing identifies a third-party MCP server. MCPBundles is not affiliated with, sponsored by, or endorsed by the service or its operator unless stated on this page.
https://jointextkit.comhttps://mcp.jointextkit.com/mcpThis server may ask you to sign in when your AI client connects.
Last probed Nov 3, 2026 · mcp.jointextkit.com
152tools discovered
Showing 25 of 152
Showing 25 of 152 tools from the public preview. Connect the server to inspect the full live tool list.
Send message
send_messageSend one SMS from one of your numbers. Set category "marketing" for promotions (the opt-in check applies) and scheduled_at to send later. Quiet hours apply to every message: outside 8am-9pm (8pm in Florida, Maryland and Oklahoma) in the recipient's local time a marketing message is refused and anything else is held until 8am, except one-time codes and replies within 4 hours of their text. In sandbox (test keys), delivery is simulated: +15005550006 delivers, +15005550002 fails, +15005550007 is fi
Description may be truncated on the public preview.
Add to workspace[
{
"name": "send_message",
"title": "Send message",
"annotations": {
"readOnlyHint": false
},
"description": "Send one SMS from one of your numbers. Set category \"marketing\" for promotions (the opt-in check applies) and scheduled_at to send later. Quiet hours apply to every message: outside 8am-9pm (8pm in Florida, Maryland and Oklahoma) in the recipient's local time a marketing message is refused and anything else is held until 8am, except one-time codes and replies within 4 hours of their text. In sandbox (test keys), delivery is simulated: +15005550006 delivers, +15005550002 fails, +15005550007 is filtered as spam, +15005550013 delivers after a delay, +15005550016 has no opt-in (see /docs/sandbox).",
"inputSchema": {
"type": "object",
"required": [
"to",
"body"
],
"properties": {
"to": {
"type": "string",
"description": "Recipient's number in E.164"
},
"body": {
"type": "string",
"maxLength": 1600,
"description": "The message text"
},
"from": {
"type": "string",
"description": "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."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 32
},
"maxItems": 10,
"description": "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 GET /v1/messages?tag=."
},
"media": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"description": "Reserved for MMS; currently returns 400 mms_not_enabled."
},
"consent": {
"type": "object",
"required": [
"source",
"collected_at"
],
"properties": {
"source": {
"enum": [
"web_form",
"keyword",
"paper",
"checkout",
"verbal"
],
"type": "string",
"description": "How the recipient agreed"
},
"page_url": {
"type": "string",
"format": "uri",
"description": "Required for web_form: the page the form was on."
},
"collected_at": {
"type": "string",
"description": "When they agreed: ISO timestamp or epoch ms, not in the future."
}
},
"description": "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 POST /v1/consent with proof). Not with scheduled_at."
},
"category": {
"enum": [
"marketing",
"transactional",
"otp"
],
"type": "string",
"description": "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 registration's use case is refused with 403 campaign_mismatch."
},
"customer_id": {
"type": "string",
"description": "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)."
},
"quiet_hours": {
"enum": [
"block",
"defer"
],
"type": "string",
"description": "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 8:00am. Omitted: the account default (a single marketing send is refused; every other message is held). One-time codes are never held."
},
"scheduled_at": {
"type": "string",
"description": "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, with quiet_hours defer, moved to their next 8:00am; any other message is moved."
},
"shorten_links": {
"type": "boolean",
"description": "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 have an active one (POST /link-domains). The links are checked as you wrote them; segments are counted on the shortened text. Works with scheduled_at."
},
"idempotency_key": {
"type": "string",
"maxLength": 200,
"description": "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."
},
"status_callback": {
"type": "string",
"format": "uri",
"description": "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 and retried like a webhook endpoint, under endpoint `status_callback`. Immediate sends only."
}
}
}
},
{
"name": "get_message",
"title": "Get message",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve a message by its msg_... id, with its delivery timeline.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Message id (msg_...)"
}
}
}
},
{
"name": "delete_message",
"title": "Delete message",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Message id (msg_...)"
}
}
}
},
{
"name": "redact_message",
"title": "Redact message",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Message id (msg_...)"
}
}
}
},
{
"name": "list_messages",
"title": "List messages",
"annotations": {
"readOnlyHint": true
},
"description": "List your messages, newest first. Filter by number, direction, status, failure reason, date, batch schedule or customer.",
"inputSchema": {
"type": "object",
"properties": {
"to": {
"type": "string",
"description": "Exact destination number (E.164)"
},
"tag": {
"type": "string",
"description": "Filter to messages sent with this tag"
},
"from": {
"type": "string",
"description": "Exact sending number (E.164)"
},
"limit": {
"type": "number",
"description": "Max results (default 25, max 100)"
},
"cursor": {
"type": "string",
"description": "next_cursor from the previous page"
},
"number": {
"type": "string",
"description": "Filter to messages to or from this number"
},
"status": {
"enum": [
"queued",
"sent",
"delivered",
"failed",
"blocked",
"received"
],
"type": "string",
"description": "Only messages with this status"
},
"direction": {
"enum": [
"outbound",
"inbound"
],
"type": "string",
"description": "outbound (sent) or inbound (received)"
},
"customer_id": {
"type": "string",
"description": "Filter to one customer's messages"
},
"schedule_id": {
"type": "string",
"description": "Filter to the occurrences of one recurring schedule (sch_...)"
},
"failure_code": {
"enum": [
"carrier_filtered",
"unreachable",
"invalid_number",
"opted_out",
"campaign_mismatch",
"content_blocked",
"screen_unavailable",
"rate_limited",
"landline",
"carrier_rejected",
"spend_limit_reached",
"insufficient_credits",
"billing_required",
"sender_not_registered",
"quiet_hours",
"consent_required",
"reconfirmation_pending",
"reconfirmation_expired",
"held_for_review",
"review_rejected",
"review_expired",
"campaign_paused",
"sender_rotation",
"recipient_not_verified",
"quota_exceeded",
"destination_not_allowed",
"voip_number",
"toll_free_destination",
"toll_free_unverified",
"account_closed",
"account_suspended",
"account_paused",
"topic_unsubscribed",
"unknown"
],
"type": "string",
"description": "Filter to messages that failed for this reason (the `failure.code` on a message)"
},
"created_after": {
"type": "string",
"description": "Inclusive. ISO timestamp or epoch ms."
},
"blocked_reason": {
"enum": [
"account_closed",
"account_suspended",
"account_paused",
"opted_out",
"destination_not_allowed",
"voip_number",
"toll_free_destination",
"toll_free_unverified",
"sender_not_registered",
"campaign_mismatch",
"rate_limited",
"recipient_not_verified",
"quiet_hours",
"consent_required",
"reconfirmation_pending",
"reconfirmation_expired",
"campaign_paused",
"sender_rotation",
"content_blocked",
"screen_unavailable",
"held_for_review",
"review_rejected",
"review_expired",
"quota_exceeded",
"spend_limit_reached",
"insufficient_credits",
"billing_required",
"topic_unsubscribed"
],
"type": "string",
"description": "Blocked messages with this reason. Implies status=blocked."
},
"created_before": {
"type": "string",
"description": "Exclusive. ISO timestamp or epoch ms."
}
}
}
},
{
"name": "send_verification",
"title": "Send verification",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"properties": {
"from": {
"type": "string",
"description": "Optional, channel `sms` only: send from a number you own instead of the TextKit pool"
},
"email": {
"type": "string",
"description": "The address to email the code to (channel `email`). Disposable addresses are refused."
},
"phone": {
"type": "string",
"description": "The number to text the code to (channel `sms`). `to` works too."
},
"channel": {
"enum": [
"sms",
"email"
],
"type": "string",
"default": "sms",
"description": "How the code goes out. `sms` needs `phone`; `email` needs `email`."
},
"user_ip": {
"type": "string",
"description": "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 your server."
},
"app_name": {
"type": "string",
"maxLength": 24,
"description": "Your product name, shown in the message"
},
"customer_id": {
"type": "string",
"description": "Optional: attribute the verification to one of your customers"
},
"idempotency_key": {
"type": "string",
"maxLength": 200,
"description": "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."
}
}
}
},
{
"name": "check_verification",
"title": "Check verification",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"description": "The code last sent"
},
"email": {
"type": "string",
"description": "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`."
},
"phone": {
"type": "string",
"description": "The number the code was texted to. Send this or `email`."
}
}
}
},
{
"name": "fallback_verification",
"title": "Fallback verification",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"id",
"email"
],
"properties": {
"id": {
"type": "string",
"description": "Verification id (ver_...)"
},
"email": {
"type": "string",
"description": "The address to email the code to"
},
"channel": {
"enum": [
"email"
],
"type": "string",
"default": "email",
"description": "The channel to fall back to. Only `email` today."
},
"user_ip": {
"type": "string",
"description": "Optional. Your end user's IP address, counted in the same per-IP limit as POST /verify."
}
}
}
},
{
"name": "list_numbers",
"title": "List numbers",
"annotations": {
"readOnlyHint": true
},
"description": "List the phone numbers on your account.",
"inputSchema": {
"type": "object",
"properties": {
"q": {
"type": "string",
"description": "Matches digits of the number or its label"
},
"tag": {
"type": "string",
"description": "Only numbers with this tag"
},
"mode": {
"enum": [
"test",
"live"
],
"type": "string",
"description": "test for sandbox numbers, live for real ones"
},
"pool": {
"type": "string",
"description": "Pool id"
},
"customer_id": {
"type": "string",
"description": "Only this customer's numbers"
}
}
}
},
{
"name": "request_short_code",
"title": "Request short code",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"type",
"business_name",
"monthly_volume",
"use_case"
],
"properties": {
"type": {
"enum": [
"short_code",
"toll_free"
],
"type": "string",
"description": "short_code, or toll_free for a number our team sets up"
},
"use_case": {
"type": "string",
"maxLength": 500,
"minLength": 10,
"description": "What you will send, in a sentence or two."
},
"business_name": {
"type": "string",
"maxLength": 120,
"description": "The business the number is for"
},
"monthly_volume": {
"enum": [
"under_1k",
"1k_10k",
"10k_100k",
"over_100k"
],
"type": "string",
"description": "Expected texts a month"
}
}
}
},
{
"name": "list_number_requests",
"title": "List number requests",
"annotations": {
"readOnlyHint": true
},
"description": "Open short-code and toll-free requests.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "search_available_numbers",
"title": "Search available numbers",
"annotations": {
"readOnlyHint": true
},
"description": "Search purchasable numbers by area code (default 415).",
"inputSchema": {
"type": "object",
"properties": {
"area_code": {
"type": "string",
"description": "Three-digit area code (default 415)"
}
}
}
},
{
"name": "purchase_number",
"title": "Purchase number",
"annotations": {
"readOnlyHint": false
},
"description": "Buy a phone number for your account (free sandbox numbers with test keys). Live numbers are billed monthly.",
"inputSchema": {
"type": "object",
"required": [
"phone_number"
],
"properties": {
"customer_id": {
"type": "string",
"description": "Optional: assign the number to one of your customers"
},
"phone_number": {
"type": "string",
"description": "The number to buy, in E.164"
},
"idempotency_key": {
"type": "string",
"maxLength": 200,
"description": "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."
},
"registration_id": {
"type": "string",
"description": "Optional (live numbers): the registration this number should send for. Without it the number follows your account's registration."
}
}
}
},
{
"name": "release_number",
"title": "Release number",
"annotations": {
"readOnlyHint": false
},
"description": "Release a number you own. It cannot be got back.",
"inputSchema": {
"type": "object",
"required": [
"phone_number"
],
"properties": {
"phone_number": {
"type": "string",
"description": "E.164 number you own"
}
}
}
},
{
"name": "lookup_phone",
"title": "Lookup phone",
"annotations": {
"readOnlyHint": true
},
"description": "Look up line type (mobile, landline, VoIP) and carrier for any US/Canada number.",
"inputSchema": {
"type": "object",
"required": [
"phone"
],
"properties": {
"phone": {
"type": "string",
"description": "E.164 number"
}
}
}
},
{
"name": "simulate_inbound",
"title": "Simulate inbound",
"annotations": {
"readOnlyHint": false
},
"description": "Sandbox only: simulate an inbound SMS to one of your test numbers (emits message.received; STOP, START and HELP act as for real).",
"inputSchema": {
"type": "object",
"required": [
"from",
"body"
],
"properties": {
"to": {
"type": "string",
"description": "One of your sandbox numbers (never a live number). Optional while the account has one sandbox number."
},
"body": {
"type": "string",
"description": "The text of the simulated message"
},
"from": {
"type": "string",
"description": "Who the simulated text comes from, in E.164"
}
}
}
},
{
"name": "list_events",
"title": "List events",
"annotations": {
"readOnlyHint": true
},
"description": "List recent events (message.sent/delivered/failed/received, number.purchased/released, ...), newest first.",
"inputSchema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Only events of this type, like message.delivered"
},
"limit": {
"type": "number",
"description": "Max results (default 25, max 100)"
},
"cursor": {
"type": "string",
"description": "next_cursor from the previous page"
}
}
}
},
{
"name": "get_verification",
"title": "Get verification",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve a verification by id: its status and attempts (never the code).",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Verification id"
}
}
}
},
{
"name": "get_number",
"title": "Get number",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve one of your numbers: status, sender registration, tags, pools, customer.",
"inputSchema": {
"type": "object",
"required": [
"phone_number"
],
"properties": {
"phone_number": {
"type": "string",
"description": "E.164 number you own"
}
}
}
},
{
"name": "bulk_purchase_numbers",
"title": "Bulk purchase numbers",
"annotations": {
"readOnlyHint": false
},
"description": "Buy several numbers in one area code at once (e.g. for a sender pool). Live numbers are billed monthly each.",
"inputSchema": {
"type": "object",
"required": [
"area_code",
"quantity"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to put on the new numbers"
},
"pool_id": {
"type": "string",
"description": "Add the new numbers to this pool"
},
"quantity": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "How many numbers to buy (1 to 50)"
},
"area_code": {
"type": "string",
"description": "Three-digit area code to buy in"
},
"idempotency_key": {
"type": "string",
"maxLength": 200,
"description": "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."
}
}
}
},
{
"name": "link_number_to_registration",
"title": "Link number to registration",
"annotations": {
"readOnlyHint": false
},
"description": "Attach a number to an approved 10DLC registration so it can send that registration's traffic.",
"inputSchema": {
"type": "object",
"required": [
"phone_number",
"registration_id"
],
"properties": {
"phone_number": {
"type": "string",
"description": "E.164 number you own"
},
"registration_id": {
"type": "string",
"description": "The approved registration to attach the number to (reg_...)"
}
}
}
},
{
"name": "assign_number_to_customer",
"title": "Assign number to customer",
"annotations": {
"readOnlyHint": false
},
"description": "Platforms: attribute a number (and its messages and usage) to one of your customers, or clear it with customer_id null.",
"inputSchema": {
"type": "object",
"required": [
"phone_number",
"customer_id"
],
"properties": {
"customer_id": {
"type": "string",
"nullable": true,
"description": "A customer id, or null to unassign"
},
"phone_number": {
"type": "string",
"description": "E.164 number you own"
}
}
}
},
{
"name": "bulk_update_numbers",
"title": "Bulk update numbers",
"annotations": {
"readOnlyHint": false
},
"description": "Act on many numbers at once: tag, untag, label, add to or remove from a pool, or release. Releasing cannot be undone.",
"inputSchema": {
"type": "object",
"required": [
"ids",
"action"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1000,
"description": "Numbers to act on, in E.164"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "add_tags / remove_tags. Lowercased; up to 20 per number."
},
"label": {
"type": "string",
"nullable": true,
"maxLength": 64,
"description": "set_label; null clears"
},
"action": {
"enum": [
"add_to_pool",
"remove_from_pool",
"add_tags",
"remove_tags",
"set_label",
"release"
],
"type": "string",
"description": "add_to_pool and remove_from_pool take pool_id, add_tags and remove_tags take tags, set_label takes label, release takes confirm"
},
"confirm": {
"type": "string",
"description": "release only"
},
"pool_id": {
"type": "string",
"description": "add_to_pool / remove_from_pool"
}
}
}
},
{
"name": "export_numbers",
"title": "Export numbers",
"annotations": {
"readOnlyHint": true
},
"description": "Your numbers as CSV text.",
"inputSchema": {
"type": "object",
"properties": {
"q": {
"type": "string",
"description": "Matches digits of the number or its label"
},
"tag": {
"type": "string",
"description": "Only numbers with this tag"
},
"mode": {
"enum": [
"test",
"live"
],
"type": "string",
"description": "test for sandbox numbers, live for real ones"
},
"pool": {
"type": "string",
"description": "Pool id"
}
}
}
},
{
"name": "list_number_pools",
"title": "List number pools",
"annotations": {
"readOnlyHint": true
},
"description": "List sender pools.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "create_number_pool",
"title": "Create number pool",
"annotations": {
"readOnlyHint": false
},
"description": "Create a sender pool from numbers you own.",
"inputSchema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 64,
"description": "Pool name"
},
"routing": {
"enum": [
"sticky",
"local"
],
"type": "string",
"default": "sticky",
"description": "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."
},
"description": {
"type": "string",
"maxLength": 280,
"description": "What the pool is for"
}
}
}
},
{
"name": "get_number_pool",
"title": "Get number pool",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve a sender pool and its numbers.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Pool id"
}
}
}
},
{
"name": "update_number_pool",
"title": "Update number pool",
"annotations": {
"readOnlyHint": false
},
"description": "Rename a sender pool or change its numbers.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Pool id"
},
"name": {
"type": "string",
"description": "Pool name"
},
"routing": {
"enum": [
"sticky",
"local"
],
"type": "string",
"default": "sticky",
"description": "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."
},
"description": {
"type": "string",
"description": "What the pool is for"
}
}
}
},
{
"name": "delete_number_pool",
"title": "Delete number pool",
"annotations": {
"readOnlyHint": false
},
"description": "Delete a sender pool. Its numbers are kept.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Pool id"
}
}
}
},
{
"name": "clone_number_pool",
"title": "Clone number pool",
"annotations": {
"readOnlyHint": false
},
"description": "Copy a sender pool under a new name.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Pool id"
},
"name": {
"type": "string",
"description": "Name of the new pool"
}
}
}
},
{
"name": "import_contacts",
"title": "Import contacts",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"contacts"
],
"properties": {
"name": {
"type": "string",
"description": "A label for the import (first request only)."
},
"dry_run": {
"type": "boolean",
"description": "true returns what would change and writes nothing"
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"required": [
"phone_number"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"description": "Display name. Defaults to first + last name."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 40
},
"maxItems": 20,
"description": "Labels that group contacts"
},
"email": {
"type": "string",
"maxLength": 254,
"description": "Email address"
},
"notes": {
"type": "string",
"maxLength": 2000,
"description": "Free-text notes"
},
"state": {
"type": "string",
"maxLength": 40,
"description": "US state or Canadian province, usually a 2-letter code"
},
"fields": {
"type": "object",
"description": "Up to 20 string values (account id, plan, location...), usable in segments and as {{field:key}} merge fields",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"opt_in": {
"type": "object",
"properties": {
"at": {
"type": "string",
"description": "When they opted in: ISO timestamp, date, or epoch ms"
},
"source": {
"type": "string",
"description": "web_form, keyword, paper, checkout or verbal are stored as proof; anything else is kept as a note"
},
"status": {
"type": "boolean",
"description": "true = opted in; false = unsubscribed (recorded as an opt-out)"
},
"page_url": {
"type": "string",
"format": "uri",
"description": "The page a web-form opt-in was collected on"
},
"campaign_id": {
"type": "string",
"description": "The registration the opt-in is for. A marketing or mixed registration needs at, a recognised source, and page_url for a web form, or the row is skipped"
}
},
"description": "Import only (POST /v1/contacts/import). Stored as consent evidence; never lifts an opt-out."
},
"source": {
"type": "string",
"maxLength": 60,
"description": "Where the contact came from. Defaults to \"api\"."
},
"company": {
"type": "string",
"maxLength": 120,
"description": "Company name"
},
"last_name": {
"type": "string",
"maxLength": 80,
"description": "Last name"
},
"first_name": {
"type": "string",
"maxLength": 80,
"description": "First name"
},
"phone_number": {
"type": "string",
"description": "E.164, US or Canada"
}
}
},
"maxItems": 500,
"description": "Contacts to create or update, up to 500 per call"
},
"import_id": {
"type": "string",
"description": "From a previous response, to group several requests as one import."
},
"campaign_id": {
"type": "string",
"description": "Applies to every opt_in row that does not name its own campaign_id"
},
"check_line_types": {
"type": "boolean",
"description": "dry_run only. Looks up line types to count landlines; live lookups are paid, so only the first 500 numbers are checked."
}
}
}
},
{
"name": "plan_import",
"title": "Plan import",
"annotations": {
"readOnlyHint": true
},
"description": "Find out where an audience is and the ways to bring it in. Without source: questions to ask the person (where their people are, which group, what they can sign in to, whether consent was recorded, once or kept in sync) and the kinds of source known. With source (their words, e.g. \"Mixpanel\", \"Shopify\", \"our Postgres users table\", \"a Google Sheet\"): the ways in, best first, each with steps and a console link: an integration already syncing it, another connected tool that can read it, a 6-hourly sync connected with their key here or in the console, a push to an ingest URL, a script with a key from their environment, an export, or a CSV upload. Changes nothing.",
"inputSchema": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "Where the people are, in your words. Omit to get the questions first."
}
}
}
},
{
"name": "upsert_contact",
"title": "Upsert contact",
"annotations": {
"readOnlyHint": false
},
"description": "Create a contact, or update the existing one with the same phone_number.",
"inputSchema": {
"type": "object",
"required": [
"phone_number"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"description": "Display name. Defaults to first + last name."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 40
},
"maxItems": 20,
"description": "Labels that group contacts"
},
"email": {
"type": "string",
"maxLength": 254,
"description": "Email address"
},
"notes": {
"type": "string",
"maxLength": 2000,
"description": "Free-text notes"
},
"state": {
"type": "string",
"maxLength": 40,
"description": "US state or Canadian province, usually a 2-letter code"
},
"fields": {
"type": "object",
"description": "Up to 20 string values (account id, plan, location...), usable in segments and as {{field:key}} merge fields",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"opt_in": {
"type": "object",
"properties": {
"at": {
"type": "string",
"description": "When they opted in: ISO timestamp, date, or epoch ms"
},
"source": {
"type": "string",
"description": "web_form, keyword, paper, checkout or verbal are stored as proof; anything else is kept as a note"
},
"status": {
"type": "boolean",
"description": "true = opted in; false = unsubscribed (recorded as an opt-out)"
},
"page_url": {
"type": "string",
"format": "uri",
"description": "The page a web-form opt-in was collected on"
},
"campaign_id": {
"type": "string",
"description": "The registration the opt-in is for. A marketing or mixed registration needs at, a recognised source, and page_url for a web form, or the row is skipped"
}
},
"description": "Import only (POST /v1/contacts/import). Stored as consent evidence; never lifts an opt-out."
},
"source": {
"type": "string",
"maxLength": 60,
"description": "Where the contact came from. Defaults to \"api\"."
},
"company": {
"type": "string",
"maxLength": 120,
"description": "Company name"
},
"last_name": {
"type": "string",
"maxLength": 80,
"description": "Last name"
},
"first_name": {
"type": "string",
"maxLength": 80,
"description": "First name"
},
"phone_number": {
"type": "string",
"description": "E.164, US or Canada"
}
}
}
},
{
"name": "list_contacts",
"title": "List contacts",
"annotations": {
"readOnlyHint": true
},
"description": "List contacts, newest first. Filter by tag, segment_id, list_id, exact phone_number, or a free-text q (name, email, company).",
"inputSchema": {
"type": "object",
"properties": {
"q": {
"type": "string",
"description": "Search text"
},
"tag": {
"type": "string",
"description": "Only contacts with this tag"
},
"limit": {
"type": "number",
"description": "Max results (default 25, max 100)"
},
"cursor": {
"type": "string",
"description": "next_cursor from the previous page"
},
"list_id": {
"type": "string",
"description": "Only contacts in this list"
},
"segment_id": {
"type": "string",
"description": "Only contacts in this segment"
},
"phone_number": {
"type": "string",
"description": "E.164"
}
}
}
},
{
"name": "get_contact",
"title": "Get contact",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve a contact.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Contact id"
}
}
}
},
{
"name": "update_contact",
"title": "Update contact",
"annotations": {
"readOnlyHint": false
},
"description": "Update a contact. Only the inputs you pass change; tags and fields replace the whole list or map.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Contact id"
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 120,
"description": "Display name. Null clears it"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 40
},
"maxItems": 20,
"description": "Labels that group contacts"
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 254,
"description": "Email address. Null clears it"
},
"notes": {
"type": "string",
"nullable": true,
"maxLength": 2000,
"description": "Free-text notes. Null clears them"
},
"state": {
"type": "string",
"nullable": true,
"maxLength": 40,
"description": "US state or Canadian province, usually a 2-letter code. Null clears it"
},
"fields": {
"type": "object",
"description": "Up to 20 string values",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"source": {
"type": "string",
"nullable": true,
"maxLength": 60,
"description": "Where the contact came from. Null clears it"
},
"company": {
"type": "string",
"nullable": true,
"maxLength": 120,
"description": "Company name. Null clears it"
},
"last_name": {
"type": "string",
"nullable": true,
"maxLength": 80,
"description": "Last name. Null clears it"
},
"first_name": {
"type": "string",
"nullable": true,
"maxLength": 80,
"description": "First name. Null clears it"
},
"phone_number": {
"type": "string",
"description": "E.164, US or Canada"
}
}
}
},
{
"name": "delete_contact",
"title": "Delete contact",
"annotations": {
"readOnlyHint": false
},
"description": "Delete a contact. Messages, consent records, and topic preferences for the number are kept.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Contact id"
}
}
}
},
{
"name": "bulk_update_contacts",
"title": "Bulk update contacts",
"annotations": {
"readOnlyHint": false
},
"description": "Add tags to, remove tags from, or delete many contacts by id.",
"inputSchema": {
"type": "object",
"required": [
"action",
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 500,
"description": "Contact ids, up to 500"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 40
},
"description": "Required for add_tags and remove_tags"
},
"action": {
"enum": [
"add_tags",
"remove_tags",
"delete"
],
"type": "string",
"description": "add_tags and remove_tags take tags, delete removes the contacts"
}
}
}
},
{
"name": "set_contact_topic",
"title": "Set contact topic",
"annotations": {
"readOnlyHint": false
},
"description": "Subscribe a contact to a topic, or unsubscribe them (e.g. \"promotions\" vs \"order updates\").",
"inputSchema": {
"type": "object",
"required": [
"id",
"topic",
"subscribed"
],
"properties": {
"id": {
"type": "string",
"description": "Contact id"
},
"topic": {
"type": "string",
"description": "Topic id (see list_topics)"
},
"source": {
"type": "string",
"description": "Where the change came from, e.g. \"preference_page\". Default \"api\"."
},
"subscribed": {
"type": "boolean",
"description": "true subscribes the contact to the topic, false unsubscribes them"
}
}
}
},
{
"name": "create_list",
"title": "Create list",
"annotations": {
"readOnlyHint": false
},
"description": "Create a list: a fixed group of contacts (Audience → Lists). Membership is set by hand, unlike a segment, which follows rules.",
"inputSchema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"description": "List name"
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 200,
"description": "What the list is for"
}
}
}
},
{
"name": "list_lists",
"title": "List lists",
"annotations": {
"readOnlyHint": true
},
"description": "List contact lists with their contact counts.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "get_list",
"title": "Get list",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve a list and its contact count.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "List id"
}
}
}
},
{
"name": "update_list",
"title": "Update list",
"annotations": {
"readOnlyHint": false
},
"description": "Rename a list or change its description.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "List id"
},
"name": {
"type": "string",
"maxLength": 80,
"description": "List name"
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 200,
"description": "What the list is for"
}
}
}
},
{
"name": "delete_list",
"title": "Delete list",
"annotations": {
"readOnlyHint": false
},
"description": "Delete a list (its contacts stay).",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "List id"
}
}
}
},
{
"name": "list_list_contacts",
"title": "List list contacts",
"annotations": {
"readOnlyHint": true
},
"description": "Page through a list's contacts, most recently added first.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "List id"
},
"limit": {
"type": "integer",
"default": 25,
"maximum": 100,
"minimum": 1,
"description": "Max results (default 25, max 100)"
},
"cursor": {
"type": "string",
"description": "next_cursor from the previous page"
}
}
}
},
{
"name": "add_to_list",
"title": "Add to list",
"annotations": {
"readOnlyHint": false
},
"description": "Add contacts to a list by contact_ids and/or phone_numbers (up to 1,000; numbers must already be contacts).",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "List id"
},
"contact_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Contact ids"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Phone numbers in E.164, of existing contacts"
}
}
}
},
{
"name": "remove_from_list",
"title": "Remove from list",
"annotations": {
"readOnlyHint": false
},
"description": "Remove contacts from a list (they stay contacts).",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "List id"
},
"contact_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Contact ids"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Phone numbers in E.164, of existing contacts"
}
}
}
},
{
"name": "create_segment",
"title": "Create segment",
"annotations": {
"readOnlyHint": false
},
"description": "Save an audience (a segment, a cohort): it appears in the console under Audience → Segments, and broadcasts can be sent to it. Everyone who can be texted: one rule, status is subscribed. Contacts matching all (or any) of up to 10 rules. Attributes: tags, contact fields, custom fields (field = \"field\", key = the name), opt-in status, topic, import, created_at. Behaviour: last_message_at, last_reply_at, batch (key = batch id; value included, sent, failed, skipped or replied) and event (key = a tracked event name). Times take an ISO date or a window like 7d. It is evaluated live each time it is used, so a batch or list sent to it reaches whoever matches then.",
"inputSchema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"description": "Segment name"
},
"match": {
"enum": [
"all",
"any"
],
"type": "string",
"default": "all",
"description": "all: a contact must match every rule. any: at least one rule"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"field"
],
"properties": {
"op": {
"enum": [
"is",
"is_not",
"contains",
"not_contains",
"exists",
"not_exists",
"before",
"after"
],
"type": "string",
"description": "Text fields take is / is_not / contains / not_contains / exists / not_exists; tag takes is / is_not / exists / not_exists; status, topic, import, batch and list take is / is_not; created_at takes before / after; last_message_at, last_reply_at and event take after (at or after the time), before (it happened, and the last time was before it), exists (ever) and not_exists (never). Comparisons ignore case."
},
"key": {
"type": "string",
"description": "The custom field name (field), topic id (topic), batch id (batch), or event name (event)"
},
"field": {
"enum": [
"tag",
"first_name",
"last_name",
"name",
"email",
"company",
"state",
"source",
"field",
"import",
"status",
"topic",
"created_at",
"last_message_at",
"last_reply_at",
"batch",
"event",
"list"
],
"type": "string",
"description": "Attributes: tag, the name and profile fields, source, field (a custom field), import, status (opt-out), topic, list (in a static list), created_at. Behaviour: last_message_at (last text either way), last_reply_at (last text from them), batch (what happened to them in one batch), event (a tracked event; the newest 20,000 events are searched)."
},
"value": {
"type": "string",
"description": "status: subscribed or opted_out. topic: subscribed or unsubscribed. import: an import id. list: a list id (lst_...). batch: included, sent, failed, skipped or replied (sent, then texted the batch's number after it was created). Times (created_at, last_message_at, last_reply_at, event): an ISO date, or a window back from now such as 7d or 24h, read each time the segment is used."
}
}
},
"maxItems": 10,
"description": "Up to 10 rules that decide who matches"
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 200,
"description": "What the segment is for"
}
}
}
},
{
"name": "list_segments",
"title": "List segments",
"annotations": {
"readOnlyHint": true
},
"description": "List saved segments.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "get_segment",
"title": "Get segment",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve a segment and its rules.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Segment id"
}
}
}
},
{
"name": "update_segment",
"title": "Update segment",
"annotations": {
"readOnlyHint": false
},
"description": "Rename a segment or replace its rules.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Segment id"
},
"name": {
"type": "string",
"maxLength": 80,
"description": "Segment name"
},
"match": {
"enum": [
"all",
"any"
],
"type": "string",
"default": "all",
"description": "all: a contact must match every rule. any: at least one rule"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"field"
],
"properties": {
"op": {
"enum": [
"is",
"is_not",
"contains",
"not_contains",
"exists",
"not_exists",
"before",
"after"
],
"type": "string",
"description": "Text fields take is / is_not / contains / not_contains / exists / not_exists; tag takes is / is_not / exists / not_exists; status, topic, import, batch and list take is / is_not; created_at takes before / after; last_message_at, last_reply_at and event take after (at or after the time), before (it happened, and the last time was before it), exists (ever) and not_exists (never). Comparisons ignore case."
},
"key": {
"type": "string",
"description": "The custom field name (field), topic id (topic), batch id (batch), or event name (event)"
},
"field": {
"enum": [
"tag",
"first_name",
"last_name",
"name",
"email",
"company",
"state",
"source",
"field",
"import",
"status",
"topic",
"created_at",
"last_message_at",
"last_reply_at",
"batch",
"event",
"list"
],
"type": "string",
"description": "Attributes: tag, the name and profile fields, source, field (a custom field), import, status (opt-out), topic, list (in a static list), created_at. Behaviour: last_message_at (last text either way), last_reply_at (last text from them), batch (what happened to them in one batch), event (a tracked event; the newest 20,000 events are searched)."
},
"value": {
"type": "string",
"description": "status: subscribed or opted_out. topic: subscribed or unsubscribed. import: an import id. list: a list id (lst_...). batch: included, sent, failed, skipped or replied (sent, then texted the batch's number after it was created). Times (created_at, last_message_at, last_reply_at, event): an ISO date, or a window back from now such as 7d or 24h, read each time the segment is used."
}
}
},
"maxItems": 10,
"description": "Up to 10 rules that decide who matches"
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 200,
"description": "What the segment is for"
}
}
}
},
{
"name": "delete_segment",
"title": "Delete segment",
"annotations": {
"readOnlyHint": false
},
"description": "Delete a segment. Contacts are not touched.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Segment id"
}
}
}
},
{
"name": "query_audience",
"title": "Query audience",
"annotations": {
"readOnlyHint": false
},
"description": "Count a cohort without saving anything (nothing appears in the console): run up to 10 segment rules now and get the counts (matched, opted out, eligible to text) and the first contacts. Examples: replied in the last 7 days (last_reply_at after 7d); got a batch and did not reply (batch sent, and batch replied with is_not); started checkout but never purchased (event exists, event not_exists); VIPs not texted in 30 days. Same rule fields as a saved segment. Everyone eligible to text: one rule, status is subscribed.",
"inputSchema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"default": 25,
"maximum": 100,
"minimum": 0,
"description": "How many matching contacts to return"
},
"match": {
"enum": [
"all",
"any"
],
"type": "string",
"default": "all",
"description": "all: a contact must match every rule. any: at least one rule"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"field"
],
"properties": {
"op": {
"enum": [
"is",
"is_not",
"contains",
"not_contains",
"exists",
"not_exists",
"before",
"after"
],
"type": "string",
"description": "Text fields take is / is_not / contains / not_contains / exists / not_exists; tag takes is / is_not / exists / not_exists; status, topic, import, batch and list take is / is_not; created_at takes before / after; last_message_at, last_reply_at and event take after (at or after the time), before (it happened, and the last time was before it), exists (ever) and not_exists (never). Comparisons ignore case."
},
"key": {
"type": "string",
"description": "The custom field name (field), topic id (topic), batch id (batch), or event name (event)"
},
"field": {
"enum": [
"tag",
"first_name",
"last_name",
"name",
"email",
"company",
"state",
"source",
"field",
"import",
"status",
"topic",
"created_at",
"last_message_at",
"last_reply_at",
"batch",
"event",
"list"
],
"type": "string",
"description": "Attributes: tag, the name and profile fields, source, field (a custom field), import, status (opt-out), topic, list (in a static list), created_at. Behaviour: last_message_at (last text either way), last_reply_at (last text from them), batch (what happened to them in one batch), event (a tracked event; the newest 20,000 events are searched)."
},
"value": {
"type": "string",
"description": "status: subscribed or opted_out. topic: subscribed or unsubscribed. import: an import id. list: a list id (lst_...). batch: included, sent, failed, skipped or replied (sent, then texted the batch's number after it was created). Times (created_at, last_message_at, last_reply_at, event): an ISO date, or a window back from now such as 7d or 24h, read each time the segment is used."
}
}
},
"maxItems": 10,
"description": "Up to 10 rules that decide who matches"
},
"topic_id": {
"type": "string",
"description": "Topic id or name: eligible also removes contacts unsubscribed from it"
}
}
}
},
{
"name": "preview_segment",
"title": "Preview segment",
"annotations": {
"readOnlyHint": true
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Segment id"
},
"topic_id": {
"type": "string",
"description": "Count only contacts subscribed to this topic"
}
}
}
},
{
"name": "list_topics",
"title": "List topics",
"annotations": {
"readOnlyHint": true
},
"description": "List subscription topics.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "create_topic",
"title": "Create topic",
"annotations": {
"readOnlyHint": false
},
"description": "Create a subscription topic, so people can opt out of one kind of message (e.g. promotions) and keep others.",
"inputSchema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"description": "Topic name"
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 200,
"description": "What the topic covers"
}
}
}
},
{
"name": "create_template",
"title": "Create template",
"annotations": {
"readOnlyHint": false
},
"description": "Save a message template. Merge tags: {{first_name}}, {{name}}, {{phone}}, {{field:<custom>}}, and per-recipient variables.",
"inputSchema": {
"type": "object",
"required": [
"name",
"body"
],
"properties": {
"body": {
"type": "string",
"maxLength": 1600,
"description": "The message text, with merge tags"
},
"name": {
"type": "string",
"maxLength": 60,
"description": "Template name"
}
}
}
},
{
"name": "list_templates",
"title": "List templates",
"annotations": {
"readOnlyHint": true
},
"description": "List message templates.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "get_template",
"title": "Get template",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve a template.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Template id"
}
}
}
},
{
"name": "update_template",
"title": "Update template",
"annotations": {
"readOnlyHint": false
},
"description": "Rename or edit a template.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Template id"
},
"body": {
"type": "string",
"maxLength": 1600,
"description": "The message text, with merge tags"
},
"name": {
"type": "string",
"maxLength": 60,
"description": "Template name"
}
}
}
},
{
"name": "delete_template",
"title": "Delete template",
"annotations": {
"readOnlyHint": false
},
"description": "Delete a template.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Template id"
}
}
}
},
{
"name": "recommend_message",
"title": "Recommend message",
"annotations": {
"readOnlyHint": true
},
"description": "Which text should we send? Ranked SMS copy for a goal (abandoned_cart, welcome, winback, failed_payment, trial, promo, ... or any) by expected revenue per message, each with its evidence: the factors that moved its score, the closest published SMS-only case studies with source links, and how much comes from this account's own sends (clicks, STOPs, revenue from tracked events). Pass your own drafts in `candidates` to score them against the generated ones. Only uses the offer, code and deadline you give it. Sends and saves nothing.",
"inputSchema": {
"type": "object",
"required": [
"industry",
"company_type",
"brand",
"product"
],
"properties": {
"code": {
"type": "string",
"description": "Optional promo code"
},
"goal": {
"enum": [
"any",
"abandoned_cart",
"abandoned_browse",
"welcome",
"winback",
"failed_payment",
"trial",
"promo",
"re_engagement",
"post_purchase",
"back_in_stock",
"quiz",
"launch",
"transactional",
"mixed"
],
"type": "string",
"default": "any",
"description": "The message type to write, or `any` to compare the types that fit `audience`"
},
"link": {
"type": "string",
"description": "URL or merge field; default {{link}}"
},
"brand": {
"type": "string",
"maxLength": 40,
"description": "Business name as customers know it"
},
"limit": {
"type": "integer",
"default": 5,
"maximum": 20,
"minimum": 1,
"description": "How many messages to return (default 5, max 20)"
},
"offer": {
"type": "string",
"description": "Optional, e.g. \"50% off your first month\". Without one no candidate has an offer"
},
"product": {
"type": "string",
"maxLength": 60,
"description": "What is being sold, as the customer would say it, e.g. \"your second number\""
},
"audience": {
"type": "string",
"description": "Who gets it, in words, e.g. \"opened the paywall and left\""
},
"deadline": {
"type": "string",
"description": "Optional, e.g. \"tonight\""
},
"industry": {
"enum": [
"apparel",
"home_goods",
"food_beverage",
"restaurant",
"beauty",
"health_wellness",
"cannabis",
"hospitality",
"consumer_app",
"fintech",
"fitness",
"pets",
"arts_crafts",
"jewelry_accessories",
"sporting_goods",
"electronics",
"services",
"other"
],
"type": "string",
"description": "The sender's industry"
},
"candidates": {
"type": "string",
"description": "Your own drafts to score: a JSON array of up to 10 strings"
},
"first_name": {
"type": "boolean",
"description": "Your contacts have first names, so candidates may use {{first_name}}"
},
"use_history": {
"type": "boolean",
"default": true,
"description": "false ranks on the case studies only"
},
"company_type": {
"enum": [
"ecommerce",
"subscription_ecommerce",
"subscription_app",
"consumer_app",
"restaurant",
"hospitality",
"retail",
"marketplace",
"fintech",
"services"
],
"type": "string",
"description": "Kind of business"
},
"first_message": {
"type": "boolean",
"description": "The first text these people get from the number: the brand and opt-out line are added and counted"
}
}
}
},
{
"name": "send_batch",
"title": "Send batch",
"annotations": {
"readOnlyHint": false
},
"description": "Send one message to many people (a broadcast or campaign): pick recipients by segment_id, tags, contact_ids, or an explicit recipients list. Opted-out numbers, numbers without marketing consent, and people unsubscribed from topic_id are removed before sending. dry_run: true sends nothing and returns the count, cost, rejected rows and consent.no_opt_in (recipients the send will skip for having no opt-in). Leave out `from` and TextKit picks a number approved for `category` (marketing unless you say otherwise), one per recipient; `sender` shows them, and with none approved it answers 400 and sends nothing. scheduled_at sends later (up to 30 days). shorten_links: true tracks link clicks: suggest it whenever the text has a link. With a live key it texts real people.",
"inputSchema": {
"type": "object",
"required": [
"body"
],
"properties": {
"body": {
"type": "string",
"maxLength": 1600,
"description": "The message text. Merge tags fill per recipient"
},
"from": {
"type": "string",
"description": "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."
},
"name": {
"type": "string",
"maxLength": 80,
"description": "A name for the broadcast"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Send to contacts carrying any of these tags (instead of recipients)."
},
"dry_run": {
"type": "boolean",
"description": "Validate only: returns a BatchValidation and sends nothing."
},
"list_id": {
"type": "string",
"description": "Send to the contacts in this list, as it is when the batch is created (instead of recipients)."
},
"category": {
"enum": [
"marketing",
"transactional",
"otp"
],
"type": "string",
"description": "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 is marketing."
},
"topic_id": {
"type": "string",
"description": "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."
},
"recipients": {
"type": "array",
"items": {
"type": "object",
"required": [
"to"
],
"properties": {
"to": {
"type": "string",
"description": "Recipient's number in E.164"
},
"variables": {
"type": "object",
"description": "Merge values for this recipient, by name",
"additionalProperties": {
"type": "string"
}
}
}
},
"maxItems": 10000,
"description": "Explicit recipients, up to 10,000"
},
"segment_id": {
"type": "string",
"description": "Send to the contacts in this saved segment, evaluated when the batch is created (instead of recipients)."
},
"contact_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Send to these contacts, by id"
},
"quiet_hours": {
"enum": [
"block",
"defer"
],
"type": "string",
"description": "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 8:00am. Omitted: each recipient in quiet hours is held until their 8:00am."
},
"scheduled_at": {
"type": "string",
"description": "Future ISO timestamp or epoch ms, up to 30 days out."
},
"shorten_links": {
"type": "boolean",
"description": "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."
},
"check_line_types": {
"type": "boolean",
"description": "Reject landlines (first 500 unique numbers are checked)."
}
}
}
},
{
"name": "list_batches",
"title": "List batches",
"annotations": {
"readOnlyHint": true
},
"description": "List batches (broadcasts), newest first.",
"inputSchema": {
"type": "object",
"properties": {
"limit": {
"type": "number",
"description": "Max results (default 25, max 100)"
},
"cursor": {
"type": "string",
"description": "next_cursor from the previous page"
},
"status": {
"enum": [
"scheduled",
"sending",
"paused",
"complete",
"canceled"
],
"type": "string",
"description": "Only batches with this status"
}
}
}
},
{
"name": "get_batch",
"title": "Get batch",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve a batch with its progress counts.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Batch id"
}
}
}
},
{
"name": "get_batch_results",
"title": "Get batch results",
"annotations": {
"readOnlyHint": true
},
"description": "Results of a batch: delivered, failed, pending, replies, opt-outs (stops), spend, and failures grouped by reason.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Batch id"
}
}
}
},
{
"name": "list_batch_recipients",
"title": "List batch recipients",
"annotations": {
"readOnlyHint": true
},
"description": "List a batch's recipients with each one's status.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Batch id"
},
"limit": {
"type": "number",
"description": "Max results (default 25, max 100)"
},
"cursor": {
"type": "string",
"description": "next_cursor from the previous page"
},
"status": {
"enum": [
"queued",
"paused",
"sent",
"failed",
"skipped",
"canceled"
],
"type": "string",
"description": "Only recipients with this status"
}
}
}
},
{
"name": "pause_batch",
"title": "Pause batch",
"annotations": {
"readOnlyHint": false
},
"description": "Pause a sending or scheduled batch.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Batch id"
}
}
}
},
{
"name": "resume_batch",
"title": "Resume batch",
"annotations": {
"readOnlyHint": false
},
"description": "Resume a paused batch.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Batch id"
}
}
}
},
{
"name": "cancel_batch",
"title": "Cancel batch",
"annotations": {
"readOnlyHint": false
},
"description": "Cancel a batch. Messages already sent stay sent.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Batch id"
}
}
}
},
{
"name": "retry_batch",
"title": "Retry batch",
"annotations": {
"readOnlyHint": false
},
"description": "Retry a batch's failed recipients.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Batch id"
}
}
}
},
{
"name": "track_event",
"title": "Track event",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"event"
],
"properties": {
"event": {
"type": "string",
"maxLength": 64,
"description": "Letters, digits, and _ . : -"
},
"phone": {
"type": "string",
"description": "The person's number in E.164"
},
"user_id": {
"type": "string",
"maxLength": 128,
"description": "Your id for the person. Sent with phone, it links the two, so later events need only user_id"
},
"properties": {
"type": "object",
"description": "Up to 20 scalar values; usable as merge fields and in conditions."
},
"idempotency_key": {
"type": "string",
"maxLength": 200,
"description": "Optional. A unique key for this call: a retry with the same key is recorded once."
}
}
}
},
{
"name": "plan_task",
"title": "Plan task",
"annotations": {
"readOnlyHint": true
},
"description": "The questions behind anything a person does here, with this account's options for each: send a text, buy or release a number, register for 10DLC, verify a toll-free number, request a short code, verification codes, a recurring text, a segment, template, list, topic, connecting a tool, a webhook, an API key, a link domain, a spend limit, a number pool, importing opt-outs, automations, broadcasts. task: a key or the person's words (\"buy a number\"); omit it for the list. Each question names the fields it fills; inputs lists every field the API takes; rules, gaps, and person_submits when the person files it in the console. Changes nothing.",
"inputSchema": {
"type": "object",
"properties": {
"task": {
"type": "string",
"description": "A task key (buy_number, register_10dlc, ...) or the person's own words (\"buy a number\"). Omit to list the tasks."
}
}
}
},
{
"name": "plan_campaign",
"title": "Plan campaign",
"annotations": {
"readOnlyHint": true
},
"description": "Every input a send needs, as questions to ask the person, with this account's options for each. kind automation: the event that starts it (tracked events with their properties, and the Mixpanel events mapped to them), filters, how long after the event to text, the event that ends it, follow-ups, repeats, who gets it, the message, link, sender and topic. kind broadcast: audience, who to leave out, message, when, sender, topic, follow-up. Also who never gets the text (exclusions) and what is missing (gaps). Changes nothing.",
"inputSchema": {
"type": "object",
"properties": {
"kind": {
"enum": [
"automation",
"broadcast"
],
"type": "string",
"default": "automation",
"description": "automation (texts started by an event) or broadcast (one send to an audience)."
}
}
}
},
{
"name": "create_automation",
"title": "Create automation",
"annotations": {
"readOnlyHint": false
},
"description": "Create a triggered text flow (as a draft): when trigger.event is tracked, run steps such as send_sms, wait, wait_for_event, and condition branches. Example: on cart_abandoned, wait 3600s, then if checkout_completed was not received send a reminder. For events that repeat, trigger.cooldown_seconds stops the same person starting it again for that long. Merge fields like {{plan}} fill from the trigger event's properties; `issues` names any no tracked event carries. Leave out `from` and TextKit picks a number approved for `category` (marketing, transactional for alerts, otp for codes) when it sends; `sender` shows the numbers, and `issues` says so when none is approved yet. Pass `from` only to pin a number. Drafts send nothing until activated.",
"inputSchema": {
"type": "object",
"properties": {
"from": {
"type": "string",
"nullable": true,
"description": "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."
},
"name": {
"type": "string",
"maxLength": 80,
"description": "Automation name"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"description": "Stable handle for goto branches; assigned when omitted."
},
"body": {
"type": "string",
"maxLength": 1600,
"description": "send_sms. Merge fields: event properties by name, {{first_name}}, {{name}}, {{phone}}, {{field:<custom>}}."
},
"from": {
"type": "string",
"description": "send_sms: overrides the flow sender."
},
"type": {
"enum": [
"send_sms",
"wait",
"wait_for_event",
"condition",
"end"
],
"type": "string",
"description": "What the step does"
},
"check": {
"type": "object",
"description": "{kind: event_received, event} | {kind: property, property, op, value?} | {kind: contact_field, field, op, value?}. op: eq, neq, contains, gt, lt, exists, not_exists."
},
"event": {
"type": "string",
"description": "wait_for_event: the event to wait for"
},
"on_met": {
"type": "string",
"description": "condition: where to go when the check passes: continue, end, or goto:<step id>"
},
"seconds": {
"type": "integer",
"maximum": 2592000,
"minimum": 60,
"description": "wait: how long, from 60 seconds to 30 days"
},
"on_not_met": {
"type": "string",
"description": "condition: where to go when the check fails: continue, end, or goto:<step id>"
},
"on_timeout": {
"type": "string",
"description": "wait_for_event: where to go when time runs out: continue, end, or goto:<step id>"
},
"on_received": {
"type": "string",
"description": "wait_for_event: where to go when the event arrives: continue, end, or goto:<step id>"
},
"timeout_seconds": {
"type": "integer",
"maximum": 2592000,
"minimum": 60,
"description": "wait_for_event: how long to wait, from 60 seconds to 30 days"
}
},
"description": "One of: send_sms {body, from?}; 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>\"."
},
"maxItems": 20,
"description": "Up to 20 steps, run in order"
},
"trigger": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The tracked event that starts a run"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"description": "eq, neq, contains, gt, lt, exists or not_exists"
},
"value": {
"description": "The value to compare with. Not used by exists or not_exists"
},
"property": {
"type": "string",
"description": "The event property to check"
}
}
},
"maxItems": 5,
"description": "Up to 5 checks on the event's properties. All must hold"
},
"cooldown_seconds": {
"type": "integer",
"maximum": 7776000,
"minimum": 60,
"description": "Optional. After a run starts for a person, they do not start another for this long (for events that repeat, like a paywall view)."
}
},
"description": "What starts a run: an event, with optional filters"
},
"category": {
"enum": [
"marketing",
"transactional",
"otp"
],
"type": "string",
"nullable": true,
"description": "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."
},
"topic_id": {
"type": "string",
"nullable": true,
"description": "Skip recipients unsubscribed from this topic."
}
}
}
},
{
"name": "list_automations",
"title": "List automations",
"annotations": {
"readOnlyHint": true
},
"description": "List automations.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "get_automation",
"title": "Get automation",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve an automation with its trigger and steps.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Automation id"
}
}
}
},
{
"name": "update_automation",
"title": "Update automation",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Automation id"
},
"from": {
"type": "string",
"nullable": true,
"description": "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."
},
"name": {
"type": "string",
"maxLength": 80,
"description": "Automation name"
},
"step": {
"type": "object",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"description": "Stable handle for goto branches; assigned when omitted."
},
"body": {
"type": "string",
"maxLength": 1600,
"description": "send_sms. Merge fields: event properties by name, {{first_name}}, {{name}}, {{phone}}, {{field:<custom>}}."
},
"from": {
"type": "string",
"description": "send_sms: overrides the flow sender."
},
"type": {
"enum": [
"send_sms",
"wait",
"wait_for_event",
"condition",
"end"
],
"type": "string",
"description": "What the step does"
},
"check": {
"type": "object",
"description": "{kind: event_received, event} | {kind: property, property, op, value?} | {kind: contact_field, field, op, value?}. op: eq, neq, contains, gt, lt, exists, not_exists."
},
"event": {
"type": "string",
"description": "wait_for_event: the event to wait for"
},
"on_met": {
"type": "string",
"description": "condition: where to go when the check passes: continue, end, or goto:<step id>"
},
"seconds": {
"type": "integer",
"maximum": 2592000,
"minimum": 60,
"description": "wait: how long, from 60 seconds to 30 days"
},
"on_not_met": {
"type": "string",
"description": "condition: where to go when the check fails: continue, end, or goto:<step id>"
},
"on_timeout": {
"type": "string",
"description": "wait_for_event: where to go when time runs out: continue, end, or goto:<step id>"
},
"on_received": {
"type": "string",
"description": "wait_for_event: where to go when the event arrives: continue, end, or goto:<step id>"
},
"timeout_seconds": {
"type": "integer",
"maximum": 2592000,
"minimum": 60,
"description": "wait_for_event: how long to wait, from 60 seconds to 30 days"
}
},
"description": "One of: send_sms {body, from?}; 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>\"."
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"description": "Stable handle for goto branches; assigned when omitted."
},
"body": {
"type": "string",
"maxLength": 1600,
"description": "send_sms. Merge fields: event properties by name, {{first_name}}, {{name}}, {{phone}}, {{field:<custom>}}."
},
"from": {
"type": "string",
"description": "send_sms: overrides the flow sender."
},
"type": {
"enum": [
"send_sms",
"wait",
"wait_for_event",
"condition",
"end"
],
"type": "string",
"description": "What the step does"
},
"check": {
"type": "object",
"description": "{kind: event_received, event} | {kind: property, property, op, value?} | {kind: contact_field, field, op, value?}. op: eq, neq, contains, gt, lt, exists, not_exists."
},
"event": {
"type": "string",
"description": "wait_for_event: the event to wait for"
},
"on_met": {
"type": "string",
"description": "condition: where to go when the check passes: continue, end, or goto:<step id>"
},
"seconds": {
"type": "integer",
"maximum": 2592000,
"minimum": 60,
"description": "wait: how long, from 60 seconds to 30 days"
},
"on_not_met": {
"type": "string",
"description": "condition: where to go when the check fails: continue, end, or goto:<step id>"
},
"on_timeout": {
"type": "string",
"description": "wait_for_event: where to go when time runs out: continue, end, or goto:<step id>"
},
"on_received": {
"type": "string",
"description": "wait_for_event: where to go when the event arrives: continue, end, or goto:<step id>"
},
"timeout_seconds": {
"type": "integer",
"maximum": 2592000,
"minimum": 60,
"description": "wait_for_event: how long to wait, from 60 seconds to 30 days"
}
},
"description": "One of: send_sms {body, from?}; 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>\"."
},
"maxItems": 20,
"description": "Replaces every step."
},
"trigger": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The tracked event that starts a run"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"description": "eq, neq, contains, gt, lt, exists or not_exists"
},
"value": {
"description": "The value to compare with. Not used by exists or not_exists"
},
"property": {
"type": "string",
"description": "The event property to check"
}
}
},
"maxItems": 5,
"description": "Up to 5 checks on the event's properties. All must hold"
},
"cooldown_seconds": {
"type": "integer",
"maximum": 7776000,
"minimum": 60,
"description": "Optional. After a run starts for a person, they do not start another for this long (for events that repeat, like a paywall view)."
}
},
"description": "What starts a run: an event, with optional filters"
},
"category": {
"enum": [
"marketing",
"transactional",
"otp"
],
"type": "string",
"nullable": true,
"description": "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."
},
"topic_id": {
"type": "string",
"nullable": true,
"description": "Skip recipients unsubscribed from this topic."
},
"if_updated_at": {
"type": "string",
"format": "date-time",
"description": "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."
}
}
}
},
{
"name": "delete_automation",
"title": "Delete automation",
"annotations": {
"readOnlyHint": false
},
"description": "Delete an automation.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Automation id"
}
}
}
},
{
"name": "activate_automation",
"title": "Activate automation",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Automation id"
}
}
}
},
{
"name": "pause_automation",
"title": "Pause automation",
"annotations": {
"readOnlyHint": false
},
"description": "Pause an automation: no new runs start, and runs in progress wait where they are until it is activated again.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Automation id"
}
}
}
},
{
"name": "preview_automation",
"title": "Preview automation",
"annotations": {
"readOnlyHint": true
},
"description": "See an automation's texts exactly as they would go out, without sending: works on drafts. Pass sample event properties (e.g. {\"amount\": 9.99}) and optionally `to` for a contact's merge fields. Returns each send_sms step's final text (brand and opt-out wording added as we would), segments, encoding, estimated cost, and merge fields that would come out empty.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Automation id"
},
"to": {
"type": "string",
"description": "E.164. Fills contact merge fields and reads what this person has already been shown"
},
"properties": {
"type": "object",
"description": "Sample event properties for merge fields, e.g. {\"plan\": \"pro\"}",
"additionalProperties": true
}
}
}
},
{
"name": "test_automation",
"title": "Test automation",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"id",
"to"
],
"properties": {
"id": {
"type": "string",
"description": "Automation id"
},
"to": {
"type": "string",
"description": "E.164: your own verified phone or a verified recipient"
},
"from": {
"type": "string",
"description": "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."
},
"steps": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only these send_sms step ids. Default: all of them"
},
"properties": {
"type": "object",
"description": "Sample event properties for merge fields",
"additionalProperties": true
},
"idempotency_key": {
"type": "string",
"maxLength": 200,
"description": "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."
}
}
}
},
{
"name": "list_automation_runs",
"title": "List automation runs",
"annotations": {
"readOnlyHint": true
},
"description": "List an automation's runs, newest first.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Automation id"
},
"limit": {
"type": "number",
"description": "Max results (default 25, max 100)"
},
"cursor": {
"type": "string",
"description": "next_cursor from the previous page"
}
}
}
},
{
"name": "get_automation_run",
"title": "Get automation run",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve one run with its step-by-step timeline.",
"inputSchema": {
"type": "object",
"required": [
"id",
"run_id"
],
"properties": {
"id": {
"type": "string",
"description": "Automation id"
},
"run_id": {
"type": "string",
"description": "Run id"
}
}
}
},
{
"name": "cancel_automation_run",
"title": "Cancel automation run",
"annotations": {
"readOnlyHint": false
},
"description": "Cancel a run in progress.",
"inputSchema": {
"type": "object",
"required": [
"id",
"run_id"
],
"properties": {
"id": {
"type": "string",
"description": "Automation id"
},
"run_id": {
"type": "string",
"description": "Run id"
}
}
}
},
{
"name": "get_topic",
"title": "Get topic",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve a topic.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Topic id"
}
}
}
},
{
"name": "update_topic",
"title": "Update topic",
"annotations": {
"readOnlyHint": false
},
"description": "Rename or describe a topic.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Topic id"
},
"name": {
"type": "string",
"maxLength": 60,
"description": "Topic name"
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 200,
"description": "What the topic covers"
}
}
}
},
{
"name": "delete_topic",
"title": "Delete topic",
"annotations": {
"readOnlyHint": false
},
"description": "Delete a topic you created (built-in topics stay).",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Topic id"
}
}
}
},
{
"name": "get_contact_topics",
"title": "Get contact topics",
"annotations": {
"readOnlyHint": true
},
"description": "A contact's subscription to each topic.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Contact id"
}
}
}
},
{
"name": "get_consent",
"title": "Get consent",
"annotations": {
"readOnlyHint": true
},
"description": "Whether a number is opted in or out, per registration, with its full consent history and proof.",
"inputSchema": {
"type": "object",
"required": [
"phone"
],
"properties": {
"phone": {
"type": "string",
"description": "E.164 number"
}
}
}
},
{
"name": "set_consent",
"title": "Set consent",
"annotations": {
"readOnlyHint": false
},
"description": "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).",
"inputSchema": {
"type": "object",
"required": [
"phone",
"status"
],
"properties": {
"note": {
"type": "string",
"maxLength": 200,
"description": "A note kept on the consent record"
},
"phone": {
"type": "string",
"description": "E.164 number"
},
"proof": {
"type": "object",
"required": [
"source"
],
"properties": {
"ip": {
"type": "string",
"description": "The person's IP address when they opted in"
},
"source": {
"enum": [
"web_form",
"keyword",
"paper",
"checkout",
"verbal"
],
"type": "string",
"description": "How the opt-in was collected"
},
"page_url": {
"type": "string",
"format": "uri",
"description": "Required for web_form"
},
"disclosure": {
"type": "string",
"maxLength": 2000,
"description": "Exact disclosure wording shown"
},
"message_id": {
"type": "string",
"description": "The inbound message that was the opt-in. Required for keyword opt-ins recorded for a marketing registration"
},
"user_agent": {
"type": "string",
"maxLength": 500,
"description": "The person's browser user agent when they opted in"
},
"campaign_id": {
"type": "string",
"description": "The registration the opt-in is for (reg_...)"
},
"collected_at": {
"type": "string",
"format": "date-time",
"description": "When the person consented; defaults to now"
},
"registration_id": {
"type": "string",
"description": "The registration the opt-in is for (reg_...)"
}
},
"description": "Opt-in evidence (Messaging Policy 1.4). Accepted only with status opted_in."
},
"status": {
"enum": [
"opted_out",
"opted_in"
],
"type": "string",
"description": "opted_in or opted_out"
},
"campaign_id": {
"type": "string",
"description": "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."
}
}
}
},
{
"name": "list_opt_outs",
"title": "List opt outs",
"annotations": {
"readOnlyHint": true
},
"description": "List opted-out numbers (the suppression list).",
"inputSchema": {
"type": "object",
"properties": {
"limit": {
"type": "number",
"description": "Max results (default 25, max 100)"
},
"cursor": {
"type": "string",
"description": "next_cursor from the previous page"
}
}
}
},
{
"name": "import_opt_outs",
"title": "Import opt outs",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"phone_numbers"
],
"properties": {
"phone_numbers": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 500,
"description": "Opted-out numbers in E.164, up to 500 per call"
}
}
}
},
{
"name": "list_scheduled_messages",
"title": "List scheduled messages",
"annotations": {
"readOnlyHint": true
},
"description": "List single messages scheduled for later and not yet sent.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "get_scheduled_message",
"title": "Get scheduled message",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve a pending scheduled message.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Scheduled message id"
}
}
}
},
{
"name": "cancel_scheduled_message",
"title": "Cancel scheduled message",
"annotations": {
"readOnlyHint": false
},
"description": "Cancel a scheduled message before it sends.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Scheduled message id"
}
}
}
},
{
"name": "create_schedule",
"title": "Create schedule",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"to",
"body",
"repeat"
],
"properties": {
"to": {
"type": "string",
"description": "Recipient's number in E.164"
},
"body": {
"type": "string",
"maxLength": 1600,
"description": "The text sent each time"
},
"from": {
"type": "string",
"description": "One of your numbers. Optional when the account has exactly one number for the key's mode."
},
"repeat": {
"type": "object",
"required": [
"frequency",
"time",
"timezone"
],
"properties": {
"time": {
"type": "string",
"description": "24-hour wall-clock time, HH:MM, in `timezone`."
},
"timezone": {
"type": "string",
"description": "IANA time zone."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"description": "How often it sends"
},
"day_of_month": {
"type": "integer",
"maximum": 31,
"minimum": 1,
"description": "Monthly only, required. Months without that day run on their last day."
},
"days_of_week": {
"type": "array",
"items": {
"enum": [
"sun",
"mon",
"tue",
"wed",
"thu",
"fri",
"sat"
],
"type": "string"
},
"description": "Weekly only, required: which weekdays."
}
},
"description": "When it sends: how often, the local time and the time zone"
},
"category": {
"enum": [
"marketing",
"transactional",
"otp"
],
"type": "string",
"nullable": true,
"description": "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))."
},
"end_date": {
"type": "string",
"format": "date",
"nullable": true,
"description": "Last local date it may run (inclusive)."
},
"start_date": {
"type": "string",
"format": "date",
"nullable": true,
"description": "First local date it may run. Defaults to today."
},
"quiet_hours": {
"enum": [
"block",
"defer"
],
"type": "string",
"nullable": true,
"description": "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 8:00am. Omitted: an occurrence in quiet hours is held until the recipient's 8:00am and recorded as `deferred`."
},
"idempotency_key": {
"type": "string",
"maxLength": 200,
"description": "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."
},
"max_occurrences": {
"type": "integer",
"minimum": 1,
"nullable": true,
"description": "The schedule completes after this many messages have been sent."
}
}
}
},
{
"name": "list_schedules",
"title": "List schedules",
"annotations": {
"readOnlyHint": true
},
"description": "List recurring schedules.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "get_schedule",
"title": "Get schedule",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve a recurring schedule with its recent occurrences.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Schedule id"
}
}
}
},
{
"name": "update_schedule",
"title": "Update schedule",
"annotations": {
"readOnlyHint": false
},
"description": "Pause (active: false) or resume (active: true) a recurring schedule.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Schedule id"
},
"active": {
"type": "boolean",
"description": "false pauses, true resumes."
}
}
}
},
{
"name": "delete_schedule",
"title": "Delete schedule",
"annotations": {
"readOnlyHint": false
},
"description": "Delete a recurring schedule.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Schedule id"
}
}
}
},
{
"name": "get_balance",
"title": "Get balance",
"annotations": {
"readOnlyHint": true
},
"description": "Prepaid credit balance and auto-recharge setting.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "get_usage",
"title": "Get usage",
"annotations": {
"readOnlyHint": true
},
"description": "Usage by month, today's counters, and plan limits.",
"inputSchema": {
"type": "object",
"properties": {
"months": {
"type": "number",
"description": "How many months back (default 3)"
}
}
}
},
{
"name": "get_spend_limit",
"title": "Get spend limit",
"annotations": {
"readOnlyHint": true
},
"description": "The monthly spend limit and this month's estimated spend.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "get_deliverability",
"title": "Get deliverability",
"annotations": {
"readOnlyHint": true
},
"description": "Delivery rates by day, destination carrier, or sending number.",
"inputSchema": {
"type": "object",
"properties": {
"end_date": {
"type": "string",
"description": "YYYY-MM-DD"
},
"group_by": {
"enum": [
"day",
"carrier",
"number"
],
"type": "string",
"description": "What to group the rates by"
},
"start_date": {
"type": "string",
"description": "YYYY-MM-DD"
}
}
}
},
{
"name": "list_registrations",
"title": "List registrations",
"annotations": {
"readOnlyHint": true
},
"description": "List 10DLC brand and campaign registrations and their status. Marketing from a local number needs an approved one.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "get_registration",
"title": "Get registration",
"annotations": {
"readOnlyHint": true
},
"description": "A registration with its checks, status, and linked numbers.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Registration id"
}
}
}
},
{
"name": "list_toll_free_verifications",
"title": "List toll free verifications",
"annotations": {
"readOnlyHint": true
},
"description": "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.",
"inputSchema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"default": 25,
"maximum": 100,
"minimum": 1,
"description": "Max results (default 25, max 100)"
},
"cursor": {
"type": "string",
"description": "next_cursor from the previous page"
},
"status": {
"enum": [
"draft",
"in_review",
"submitted",
"verified",
"rejected"
],
"type": "string",
"description": "Only verifications with this status"
}
}
}
},
{
"name": "get_toll_free_verification",
"title": "Get toll free verification",
"annotations": {
"readOnlyHint": true
},
"description": "A toll-free verification: status, numbers, the form, what is missing (problems), and the carriers' reason when it was rejected.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Toll-free verification id (tfv_...)"
}
}
}
},
{
"name": "connect_integration",
"title": "Connect integration",
"annotations": {
"readOnlyHint": false
},
"description": "Connect a tool so its people sync in as contacts, in a list of their own, every 6 hours: Mixpanel (projectId, username, secret = a service account; sourceId = cohort id), Amplitude (apiKey, secretKey, sourceId), HubSpot (accessToken), Shopify (shopDomain, accessToken), Salesforce, or a webhook. Takes the event or property that shows people agreed to texts (consentEvent / consentField) and the property that holds their phone (phoneField). Credentials are proved with one read, sealed, and never returned. Mixpanel also takes eventTriggers, which turn Mixpanel events into TextKit events that start, end or branch automations; `warnings` names mapped events with no volume in 7 days.",
"inputSchema": {
"type": "object",
"required": [
"provider"
],
"properties": {
"mode": {
"enum": [
"pull",
"push"
],
"type": "string",
"description": "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."
},
"name": {
"type": "string",
"description": "What to call it (default: the tool and its source)."
},
"apiKey": {
"type": "string",
"description": "Amplitude API key."
},
"region": {
"enum": [
"us",
"eu"
],
"type": "string",
"description": "Mixpanel / Amplitude data residency."
},
"secret": {
"type": "string",
"description": "Mixpanel service account secret."
},
"clientId": {
"type": "string",
"description": "Salesforce consumer key, or Shopify client id."
},
"provider": {
"enum": [
"shopify",
"hubspot",
"salesforce",
"mixpanel",
"amplitude",
"webhook"
],
"type": "string",
"description": "The tool to connect"
},
"sfObject": {
"enum": [
"Contact",
"Lead"
],
"type": "string",
"description": "Salesforce: the object to sync"
},
"sourceId": {
"type": "string",
"description": "Mixpanel or Amplitude cohort id; HubSpot list id; Salesforce campaign id; a Shopify customer search. Blank = everyone (HubSpot, Shopify, Salesforce)."
},
"username": {
"type": "string",
"description": "Mixpanel service account username."
},
"projectId": {
"type": "string",
"description": "Mixpanel project id."
},
"secretKey": {
"type": "string",
"description": "Amplitude secret key."
},
"phoneEvent": {
"type": "string",
"description": "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."
},
"phoneField": {
"type": "string",
"description": "The tool's property holding the mobile number, when not the usual one ($phone, phone, mobilephone)."
},
"shopDomain": {
"type": "string",
"description": "Shopify store, like acme.myshopify.com."
},
"accessToken": {
"type": "string",
"description": "HubSpot private app token, or Shopify Admin API access token."
},
"instanceUrl": {
"type": "string",
"description": "Salesforce My Domain URL."
},
"clientSecret": {
"type": "string",
"description": "Salesforce consumer secret, or Shopify client secret."
},
"consentEvent": {
"type": "string",
"description": "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."
},
"consentField": {
"type": "string",
"description": "The tool's property that records SMS consent (e.g. sms_opt_in)."
},
"eventTriggers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The TextKit event to record"
},
"mixpanel_events": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 10,
"description": "The Mixpanel events that map to it, up to 10"
}
}
},
"maxItems": 20,
"description": "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\", mixpanel_events: [\"Purchase Completed\", \"Web Trial Successful\"] }. Only events from people in the integration's list become events, matched by their Mixpanel id. [] clears them. The answer's `warnings` names mapped events that fired 0 times in the last 7 days."
},
"phoneEventProperty": {
"type": "string",
"description": "Mixpanel: that event's property holding the number (default phone)."
}
}
}
},
{
"name": "list_integrations",
"title": "List integrations",
"annotations": {
"readOnlyHint": true
},
"description": "The connected tools: status, settings, last sync (found, added, opted out), and their list. No credentials.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "get_integration",
"title": "Get integration",
"annotations": {
"readOnlyHint": true
},
"description": "One connected tool and its last sync.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Integration id"
}
}
}
},
{
"name": "update_integration",
"title": "Update integration",
"annotations": {
"readOnlyHint": false
},
"description": "Rename, pause or resume (status), or change an integration's settings or credentials (left-out credentials keep the stored ones). eventTriggers (Mixpanel) maps Mixpanel events to TextKit events; changing only those does not re-test credentials or resync.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Integration id"
},
"name": {
"type": "string",
"description": "What to call it"
},
"apiKey": {
"type": "string",
"description": "Amplitude API key"
},
"secret": {
"type": "string",
"description": "Mixpanel service account secret"
},
"status": {
"enum": [
"active",
"paused"
],
"type": "string",
"description": "active, or paused to stop syncing"
},
"sourceId": {
"type": "string",
"description": "Mixpanel or Amplitude cohort id; HubSpot list id; Salesforce campaign id; a Shopify customer search"
},
"username": {
"type": "string",
"description": "Mixpanel service account username"
},
"secretKey": {
"type": "string",
"description": "Amplitude secret key"
},
"phoneEvent": {
"type": "string",
"description": "Mixpanel: an event that carries the number when profiles do not"
},
"phoneField": {
"type": "string",
"description": "The tool's property holding the mobile number"
},
"accessToken": {
"type": "string",
"description": "HubSpot private app token, or Shopify Admin API access token"
},
"consentEvent": {
"type": "string",
"description": "Mixpanel / Amplitude: the opt-in event the cohort is built on"
},
"consentField": {
"type": "string",
"description": "The tool's property that records SMS consent"
},
"eventTriggers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The TextKit event to record"
},
"mixpanel_events": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 10,
"description": "The Mixpanel events that map to it, up to 10"
}
}
},
"maxItems": 20,
"description": "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\", mixpanel_events: [\"Purchase Completed\", \"Web Trial Successful\"] }. Only events from people in the integration's list become events, matched by their Mixpanel id. [] clears them. Changing only these keeps the credentials and the sync schedule as they are (no re-test, no resync). The answer's `warnings` names mapped events that fired 0 times in the last 7 days."
},
"phoneEventProperty": {
"type": "string",
"description": "Mixpanel: that event's property holding the number (default phone)"
}
}
}
},
{
"name": "get_integration_events",
"title": "Get integration events",
"annotations": {
"readOnlyHint": true
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Integration id"
},
"project_events": {
"type": "boolean",
"description": "Also list the Mixpanel project's event names with their 7-day volume."
}
}
}
},
{
"name": "sync_integration",
"title": "Sync integration",
"annotations": {
"readOnlyHint": false
},
"description": "Sync a connected tool now (up to 6 times an hour) and get what changed.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Integration id"
}
}
}
},
{
"name": "disconnect_integration",
"title": "Disconnect integration",
"annotations": {
"readOnlyHint": false
},
"description": "Disconnect a tool: its credentials and its list are deleted; the contacts stay with their consent.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Integration id"
}
}
}
},
{
"name": "create_webhook",
"title": "Create webhook",
"annotations": {
"readOnlyHint": false
},
"description": "Send events (message.received, message.delivered, message.opted_out, ...) to a URL: your app, a CRM, an automation tool. Returns the signing secret once.",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "The https URL that receives the events"
},
"events": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Event types to receive. Omit, or send \"*\" or [], for every event. An unknown type is a 400."
},
"numbers": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 100,
"description": "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."
},
"description": {
"type": "string",
"maxLength": 120,
"description": "A note on what the endpoint is for"
}
}
}
},
{
"name": "list_webhooks",
"title": "List webhooks",
"annotations": {
"readOnlyHint": true
},
"description": "List webhook endpoints.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "update_webhook",
"title": "Update webhook",
"annotations": {
"readOnlyHint": false
},
"description": "Change a webhook endpoint: URL, events, or turn it off (active: false).",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Webhook endpoint id"
},
"url": {
"type": "string",
"format": "uri",
"description": "The https URL that receives the events"
},
"active": {
"type": "boolean",
"description": "false pauses delivery; pending retries for a paused endpoint are dropped."
},
"events": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Event types to send, or * for all"
},
"numbers": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 100,
"nullable": true,
"description": "Replace the number filter; [] or null clears it."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 120,
"description": "A note on what the endpoint is for"
}
}
}
},
{
"name": "delete_webhook",
"title": "Delete webhook",
"annotations": {
"readOnlyHint": false
},
"description": "Delete a webhook endpoint.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Webhook endpoint id"
}
}
}
},
{
"name": "rotate_webhook_secret",
"title": "Rotate webhook secret",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Webhook endpoint id"
},
"expire_previous_in": {
"type": "integer",
"default": 0,
"maximum": 604800,
"minimum": 0,
"description": "Seconds the old secret keeps signing alongside the new one."
}
}
}
},
{
"name": "test_webhook",
"title": "Test webhook",
"annotations": {
"readOnlyHint": false
},
"description": "Send a signed test.ping to a webhook endpoint and see what it answered.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Webhook endpoint id"
}
}
}
},
{
"name": "replay_failed_webhooks",
"title": "Replay failed webhooks",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Webhook endpoint id"
},
"since": {
"type": "string",
"format": "date-time",
"description": "ISO date or epoch milliseconds. Default: 24 hours before `until`."
},
"until": {
"type": "string",
"format": "date-time",
"description": "ISO date or epoch milliseconds. Default: now."
}
}
}
},
{
"name": "create_link",
"title": "Create link",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Where the link goes. Public shorteners and look-alike domains are refused."
},
"name": {
"type": "string",
"maxLength": 80,
"description": "Optional. Your name for it."
}
}
}
},
{
"name": "list_links",
"title": "List links",
"annotations": {
"readOnlyHint": true
},
"description": "Every tracked destination with its texts, clicks, conversions and value. The answer to \"which link worked?\".",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "record_conversion",
"title": "Record conversion",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"click_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"description": "Optional. What happened, like purchase."
},
"click_id": {
"type": "string",
"description": "The `tk` value on the landing page URL."
},
"external_id": {
"type": "string",
"maxLength": 128,
"description": "Optional. Your id for it. The same id twice counts once and returns the first with 200."
},
"value_cents": {
"type": "integer",
"minimum": 0,
"description": "Optional. What it was worth, in US cents."
}
}
}
},
{
"name": "list_conversions",
"title": "List conversions",
"annotations": {
"readOnlyHint": true
},
"description": "The latest 100 conversions, newest first.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "list_link_domains",
"title": "List link domains",
"annotations": {
"readOnlyHint": true
},
"description": "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.",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "get_link_domain",
"title": "Get link domain",
"annotations": {
"readOnlyHint": true
},
"description": "One short-link domain, with the DNS records it needs.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Link domain id (ld_...)"
}
}
}
},
{
"name": "create_link_domain",
"title": "Create link domain",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "A subdomain you own, like links.example.com"
}
}
}
},
{
"name": "verify_link_domain",
"title": "Verify link domain",
"annotations": {
"readOnlyHint": false
},
"description": "Check a link domain's DNS records now. When both are found it is turned on (active) at once.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Link domain id (ld_...)"
}
}
}
},
{
"name": "get_webhook",
"title": "Get webhook",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve a webhook endpoint.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Webhook endpoint id"
}
}
}
},
{
"name": "list_webhook_deliveries",
"title": "List webhook deliveries",
"annotations": {
"readOnlyHint": true
},
"description": "Delivery attempts to your webhook endpoints, with response status codes.",
"inputSchema": {
"type": "object",
"properties": {
"limit": {
"type": "number",
"description": "Max results (default 25, max 100)"
},
"cursor": {
"type": "string",
"description": "next_cursor from the previous page"
},
"event_id": {
"type": "string",
"description": "Every attempt for one event"
},
"endpoint_id": {
"type": "string",
"description": "One endpoint (we_...), or status_callback for the attempts to send messages' own status callbacks."
}
}
}
},
{
"name": "replay_event",
"title": "Replay event",
"annotations": {
"readOnlyHint": false
},
"description": "Send an event again to one webhook endpoint (after fixing the receiver).",
"inputSchema": {
"type": "object",
"required": [
"id",
"endpoint_id"
],
"properties": {
"id": {
"type": "string",
"description": "Event id"
},
"endpoint_id": {
"type": "string",
"description": "The webhook endpoint to send it to (we_...)"
}
}
}
},
{
"name": "create_customer",
"title": "Create customer",
"annotations": {
"readOnlyHint": false
},
"description": "Platforms sending for other businesses: create a customer to attribute numbers, messages and usage to.",
"inputSchema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 200,
"description": "The customer's name"
},
"metadata": {
"type": "object",
"description": "Up to 50 string values",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"external_id": {
"type": "string",
"nullable": true,
"maxLength": 200,
"description": "Your id for them; unique per account"
}
}
}
},
{
"name": "list_customers",
"title": "List customers",
"annotations": {
"readOnlyHint": true
},
"description": "List your customers.",
"inputSchema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"default": 25,
"maximum": 100,
"description": "Max results (default 25, max 100)"
},
"cursor": {
"type": "string",
"description": "next_cursor from the previous page"
},
"external_id": {
"type": "string",
"description": "Find the customer with this external_id (0 or 1 results)"
}
}
}
},
{
"name": "get_customer",
"title": "Get customer",
"annotations": {
"readOnlyHint": true
},
"description": "Retrieve a customer.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Customer id"
}
}
}
},
{
"name": "update_customer",
"title": "Update customer",
"annotations": {
"readOnlyHint": false
},
"description": "Rename a customer or change its external_id or metadata.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Customer id"
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 200,
"description": "The customer's name"
},
"metadata": {
"type": "object",
"description": "Up to 50 string values",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"external_id": {
"type": "string",
"nullable": true,
"maxLength": 200,
"description": "Your id for them; unique per account"
}
}
}
},
{
"name": "delete_customer",
"title": "Delete customer",
"annotations": {
"readOnlyHint": false
},
"description": "Delete a customer.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Customer id"
}
}
}
},
{
"name": "get_customer_usage",
"title": "Get customer usage",
"annotations": {
"readOnlyHint": true
},
"description": "A customer's messages, verifications and spend for a period.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Customer id"
},
"end": {
"type": "string",
"format": "date",
"description": "Default: today"
},
"start": {
"type": "string",
"format": "date",
"description": "Default: first day of this month"
}
}
}
},
{
"name": "create_api_key",
"title": "Create api key",
"annotations": {
"readOnlyHint": false
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"description": "What the key is for, e.g. \"Booking app\""
},
"scopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Limit the key to these scopes (see /docs/authentication). Omit for full access (full-access callers only)."
}
}
}
},
{
"name": "list_api_keys",
"title": "List api keys",
"annotations": {
"readOnlyHint": true
},
"description": "List the active API keys of this mode (never the secrets).",
"inputSchema": {
"type": "object",
"properties": {}
}
},
{
"name": "revoke_api_key",
"title": "Revoke api key",
"annotations": {
"readOnlyHint": false
},
"description": "Revoke an API key of this mode. Immediate and permanent: anything using it stops working.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "API key id"
}
}
}
},
{
"name": "export_csv",
"title": "Export csv",
"annotations": {
"readOnlyHint": true
},
"description": "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.",
"inputSchema": {
"type": "object",
"required": [
"kind"
],
"properties": {
"q": {
"type": "string",
"description": "messages: body/failure text; events: id/payload text"
},
"ok": {
"type": "boolean",
"description": "webhook_deliveries"
},
"to": {
"type": "string",
"description": "Inclusive; a bare date means the end of that day (UTC)"
},
"from": {
"type": "string",
"description": "ISO date/time or epoch ms (messages, deliveries, events, webhook_deliveries)"
},
"kind": {
"type": "string",
"description": "messages, deliveries, events, opt_outs, webhook_deliveries, usage, usage_monthly, audit_log or credit_history"
},
"type": {
"type": "string",
"description": "events, webhook_deliveries"
},
"actor": {
"type": "string",
"description": "audit_log: actor id or part of the actor email"
},
"batch": {
"type": "string",
"description": "messages, deliveries: batch id (bc_...)"
},
"action": {
"type": "string",
"description": "audit_log: one action, or a group prefix with a trailing dot (team.)"
},
"months": {
"type": "integer",
"default": 3,
"maximum": 12,
"minimum": 1,
"description": "usage: daily rows for the last N months"
},
"number": {
"type": "string",
"description": "messages, deliveries: digits matched against either side"
},
"status": {
"enum": [
"queued",
"sent",
"delivered",
"failed",
"blocked",
"received"
],
"type": "string",
"description": "messages, deliveries"
},
"direction": {
"enum": [
"outbound",
"inbound"
],
"type": "string",
"description": "messages"
},
"to_number": {
"type": "string",
"description": "messages, deliveries: exact recipient (E.164). `to`/`from` are the date range here."
},
"customer_id": {
"type": "string",
"description": "messages, deliveries"
},
"endpoint_id": {
"type": "string",
"description": "webhook_deliveries (default: all endpoints)"
},
"from_number": {
"type": "string",
"description": "messages, deliveries: exact sender (E.164)"
},
"target_type": {
"type": "string",
"description": "audit_log"
},
"failure_code": {
"enum": [
"carrier_filtered",
"unreachable",
"invalid_number",
"opted_out",
"campaign_mismatch",
"content_blocked",
"screen_unavailable",
"rate_limited",
"landline",
"carrier_rejected",
"spend_limit_reached",
"insufficient_credits",
"billing_required",
"sender_not_registered",
"quiet_hours",
"consent_required",
"reconfirmation_pending",
"reconfirmation_expired",
"held_for_review",
"review_rejected",
"review_expired",
"campaign_paused",
"sender_rotation",
"recipient_not_verified",
"quota_exceeded",
"destination_not_allowed",
"voip_number",
"toll_free_destination",
"toll_free_unverified",
"account_closed",
"account_suspended",
"account_paused",
"topic_unsubscribed",
"unknown"
],
"type": "string",
"description": "messages, deliveries: failed for this reason (the `failure.code` on a message)"
},
"created_after": {
"type": "string",
"description": "audit_log: same as on GET /audit-logs (from is accepted too)"
},
"blocked_reason": {
"type": "string",
"description": "messages, deliveries: blocked messages with this reason"
},
"created_before": {
"type": "string",
"description": "audit_log: same as on GET /audit-logs (to is accepted too)"
}
}
}
},
{
"name": "export_consent",
"title": "Export consent",
"annotations": {
"readOnlyHint": true
},
"description": "The suppression list, or the full consent ledger with opt-in proof, as CSV text.",
"inputSchema": {
"type": "object",
"properties": {
"type": {
"enum": [
"suppressions",
"ledger"
],
"type": "string",
"default": "suppressions",
"description": "suppressions: the opted-out numbers. ledger: every consent record, with proof"
}
}
}
},
{
"name": "list_audit_logs",
"title": "List audit logs",
"annotations": {
"readOnlyHint": true
},
"description": "Who changed what on the account (keys, team, webhooks, spend limit, numbers, consent, settings), newest first.",
"inputSchema": {
"type": "object",
"properties": {
"actor": {
"type": "string",
"description": "Actor id (exact) or part of the actor email (case-insensitive)"
},
"limit": {
"type": "integer",
"default": 25,
"maximum": 100,
"minimum": 1,
"description": "Max results (default 25, max 100)"
},
"action": {
"type": "string",
"description": "One action, or a group prefix with a trailing dot (team., api_key.)"
},
"cursor": {
"type": "string",
"description": "next_cursor from the previous page"
},
"target_type": {
"type": "string",
"description": "Target type, e.g. api_key, member, invite, webhook, number, phone"
},
"created_after": {
"type": "string",
"format": "date-time",
"description": "Entries at or after this time (ISO 8601)"
},
"created_before": {
"type": "string",
"format": "date-time",
"description": "Entries at or before this time (ISO 8601); a bare date means the end of that day (UTC)"
}
}
}
},
{
"name": "wait_for_events",
"title": "Wait for events",
"annotations": {
"readOnlyHint": true
},
"description": "Wait up to 25 seconds for the next events after a cursor (a reply, a delivery receipt), then return them.",
"inputSchema": {
"type": "object",
"properties": {
"cursor": {
"type": "string",
"description": "The `cursor` of the previous response. Omit on the first call."
},
"timeout": {
"type": "integer",
"default": 20,
"maximum": 25,
"minimum": 0,
"description": "Seconds to hold the request."
}
}
}
},
{
"name": "list_registration_submissions",
"title": "List registration submissions",
"annotations": {
"readOnlyHint": true
},
"description": "The filed copies of a 10DLC registration, newest first.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Registration id"
}
}
}
},
{
"name": "set_spend_limit",
"title": "Set spend limit",
"annotations": {
"readOnlyHint": false
},
"description": "Set or remove the monthly spend cap and its alert thresholds. Live sends over the cap are refused.",
"inputSchema": {
"type": "object",
"properties": {
"alert_thresholds": {
"type": "array",
"items": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"maxItems": 5,
"description": "Percentages of the limit to alert at, up to 5, like [50, 80, 100]"
},
"monthly_limit_usd": {
"type": "number",
"maximum": 1000000,
"minimum": 1,
"nullable": true,
"description": "null removes the cap"
}
}
}
},
{
"name": "delete_link_domain",
"title": "Delete link domain",
"annotations": {
"readOnlyHint": false
},
"description": "Remove a branded link domain. Every short link already sent on it stops working.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Link domain id"
}
}
}
},
{
"name": "forget_identity",
"title": "Forget identity",
"annotations": {
"readOnlyHint": false
},
"description": "Privacy erasure: forget the phone number linked to a user_id, so its tracked events stop reaching automations.",
"inputSchema": {
"type": "object",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "string",
"description": "Your user id"
}
}
}
}
]Get your MCP into directories
A working endpoint is step one. Directory coverage is the coordinated launch across ChatGPT, Claude, Cursor, the MCP Registry, and community indexes.
Directory coverage for brandsSMS for developers. Send and receive texts with a simple API, built for developers and AI agents. US and Canada, free to start.
Use the MCP endpoint listed on this page in your MCP client configuration. One-click install pills support Claude, Cursor, VS Code, and other hosts. Copy the remote MCP URL if your client needs a manual entry.
Request removal if you do not want TextKit listed here, or claim the listing if you want to manage it on MCPBundles.
This server appears in the MCPBundles directory. Verify you operate it to take over the listing — name, description, logo, contact email, and skill content. We email a 6-digit code to a maintainer address your server publishes in /.well-known/security.txt or /.well-known/mcpbundles.json. Free, takes about a minute.
MCPBundles publishes this directory for MCP discovery. Except where we host or operate an offering, third-party services run under their own terms. Product and company names on this page are used in a descriptive, identifying way (including under nominative fair use where applicable); they remain the property of their owners. Nothing here grants you rights in those marks, and nothing here is an offer to sell a third party's services. Terms · Request removal
Other MCP servers in this category from the directory index
Previewing 25 of 152 tools
MCPBundles probed 152 tools on the live server. The tool list on this page reflects what was discovered at the last refresh — connect your client to see the full set available to your session.
TextKit may require signing in to the provider before tools can run. Connect through MCPBundles or your MCP client and complete any provider login when prompted.
Request removal from the MCPBundles directory. We stop publishing this listing on mcpbundles.com.
MCPBundles is an independent platform built on the open Model Context Protocol standard. MCPBundles is not affiliated with, sponsored by, or endorsed by Anthropic PBC.