{"server":"TextKit","checked":"2026-11-22","tools":[{"name":"activate_automation","title":"Activate automation","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"add_to_list","title":"Add to list","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"assign_number_to_customer","title":"Assign number to customer","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":{"phone_number":{"type":"string","description":"E.164 number you own"},"customer_id":{"type":"string","nullable":true,"description":"A customer id, or null to unassign"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"bulk_purchase_numbers","title":"Bulk purchase numbers","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":{"area_code":{"type":"string","description":"Three-digit area code to buy in"},"quantity":{"type":"integer","minimum":1,"maximum":50,"description":"How many numbers to buy (1 to 50)"},"pool_id":{"type":"string","description":"Add the new numbers to this pool"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags to put on the new numbers"},"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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"bulk_update_contacts","title":"Bulk update contacts","description":"Add tags to, remove tags from, or delete many contacts by id.","inputSchema":{"type":"object","required":["action","ids"],"properties":{"action":{"type":"string","enum":["add_tags","remove_tags","delete"],"description":"add_tags and remove_tags take tags, delete removes the contacts"},"ids":{"type":"array","maxItems":500,"items":{"type":"string"},"description":"Contact ids, up to 500"},"tags":{"type":"array","items":{"type":"string","maxLength":40},"description":"Required for add_tags and remove_tags"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"bulk_update_numbers","title":"Bulk update numbers","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"},"action":{"type":"string","enum":["add_to_pool","remove_from_pool","add_tags","remove_tags","set_label","release"],"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"},"pool_id":{"type":"string","description":"add_to_pool / remove_from_pool"},"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"},"confirm":{"type":"string","description":"release only"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"cancel_automation_run","title":"Cancel automation run","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"cancel_batch","title":"Cancel batch","description":"Cancel a batch. Messages already sent stay sent.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Batch id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"cancel_scheduled_message","title":"Cancel scheduled message","description":"Cancel a scheduled message before it sends.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Scheduled message id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"check_verification","title":"Check verification","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":{"phone":{"type":"string","description":"The number the code was texted to. Send this or `email`."},"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`."},"code":{"type":"string","description":"The code last sent"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"clone_number_pool","title":"Clone number pool","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"connect_integration","title":"Connect integration","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":{"provider":{"type":"string","enum":["shopify","hubspot","salesforce","mixpanel","amplitude","webhook"],"description":"The tool to connect"},"mode":{"type":"string","enum":["pull","push"],"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)."},"sourceId":{"type":"string","description":"Mixpanel or Amplitude cohort id; HubSpot list id; Salesforce campaign id; a Shopify customer search. Blank = everyone (HubSpot, Shopify, Salesforce)."},"projectId":{"type":"string","description":"Mixpanel project id."},"region":{"type":"string","enum":["us","eu"],"description":"Mixpanel / Amplitude data residency."},"username":{"type":"string","description":"Mixpanel service account username."},"secret":{"type":"string","description":"Mixpanel service account secret."},"apiKey":{"type":"string","description":"Amplitude API key."},"secretKey":{"type":"string","description":"Amplitude secret key."},"accessToken":{"type":"string","description":"HubSpot private app token, or Shopify Admin API access token."},"shopDomain":{"type":"string","description":"Shopify store, like acme.myshopify.com."},"instanceUrl":{"type":"string","description":"Salesforce My Domain URL."},"sfObject":{"type":"string","enum":["Contact","Lead"],"description":"Salesforce: the object to sync"},"clientId":{"type":"string","description":"Salesforce consumer key, or Shopify client id."},"clientSecret":{"type":"string","description":"Salesforce consumer secret, or Shopify client secret."},"phoneField":{"type":"string","description":"The tool's property holding the mobile number, when not the usual one ($phone, phone, mobilephone)."},"consentField":{"type":"string","description":"The tool's property that records SMS consent (e.g. sms_opt_in)."},"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."},"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."},"phoneEventProperty":{"type":"string","description":"Mixpanel: that event's property holding the number (default phone)."},"exportEvents":{"type":"boolean","description":"Mixpanel (with a service account): send each text's events onto the person's Mixpanel profile: TextKit Message Sent, Delivered, Failed, Link Clicked, Reply Received and Opted Out, with the message, batch or automation and step ids and names. The person is matched by the batch recipient's external_id, the user id or mixpanel_distinct_id of the event that started the automation, or the contact Mixpanel supplied. On unless false. Needs a service account Mixpanel lets import (Admin or Owner on the project)."},"eventTriggers":{"type":"array","maxItems":20,"items":{"type":"object","properties":{"event":{"type":"string","description":"The TextKit event to record"},"mixpanel_events":{"type":"array","maxItems":10,"items":{"type":"string"},"description":"The Mixpanel events that map to it, up to 10"}}},"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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"create_api_key","title":"Create api key","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)."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"create_automation","title":"Create automation","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. A send_sms step with send_time: \"optimal_user_time\" and max_wait_seconds (60 to 86400, required) waits for the hour that person usually replies or clicks, 10am their time with no history, inside quiet hours: recommend it for marketing and lifecycle texts, leave it off anything time-sensitive, and it is refused for one-time codes and order or shipping texts. For events that repeat, trigger.cooldown_seconds stops the same person starting it again for that long. Merge fields like {{plan}} fill from the trigger event's properties; `issues` names any no tracked event carries. Leave out `from` and TextKit picks a number approved for `category` (marketing, transactional for alerts, otp for codes) when it sends; `sender` shows the numbers, and `issues` says so when none is approved yet. Pass `from` only to pin a number. Drafts send nothing until activated.","inputSchema":{"type":"object","properties":{"name":{"type":"string","maxLength":80,"description":"Automation name"},"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."},"category":{"type":"string","nullable":true,"enum":["marketing","transactional","otp"],"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."},"trigger":{"type":"object","properties":{"event":{"type":"string","description":"The tracked event that starts a run"},"filters":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"property":{"type":"string","description":"The event property to check"},"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"}}},"description":"Up to 5 checks on the event's properties. All must hold"},"cooldown_seconds":{"type":"integer","minimum":60,"maximum":7776000,"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"},"steps":{"type":"array","maxItems":20,"items":{"type":"object","required":["type"],"description":"One of: send_sms {body, from?, send_time?, max_wait_seconds?}; wait {seconds}; wait_for_event {event, timeout_seconds, on_received, on_timeout}; condition {check, on_met, on_not_met}; end. Branches are \"continue\", \"end\", or \"goto:<id of a later step>\".","properties":{"id":{"type":"string","description":"Stable handle for goto branches; assigned when omitted."},"type":{"type":"string","enum":["send_sms","wait","wait_for_event","condition","end"],"description":"What the step does"},"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."},"send_time":{"type":"string","enum":["right_away","optimal_user_time"],"description":"send_sms: `optimal_user_time` waits for the hour this person usually replies or clicks, inside quiet hours. Default: right_away. Refused for one-time codes and order or shipping texts."},"max_wait_seconds":{"type":"integer","minimum":60,"maximum":86400,"description":"send_sms with optimal_user_time, required: the longest this text may wait for that hour"},"seconds":{"type":"integer","minimum":60,"maximum":2592000,"description":"wait: how long, from 60 seconds to 30 days"},"event":{"type":"string","description":"wait_for_event: the event to wait for"},"timeout_seconds":{"type":"integer","minimum":60,"maximum":2592000,"description":"wait_for_event: how long to wait, from 60 seconds to 30 days"},"on_received":{"type":"string","description":"wait_for_event: where to go when the event arrives: 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>"},"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."},"on_met":{"type":"string","description":"condition: where to go when the check passes: continue, end, or goto:<step id>"},"on_not_met":{"type":"string","description":"condition: where to go when the check fails: continue, end, or goto:<step id>"}}},"description":"Up to 20 steps, run in order"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"create_customer","title":"Create customer","description":"Platforms sending for other businesses: create a customer to attribute numbers, messages and usage to.","inputSchema":{"type":"object","properties":{"name":{"type":"string","maxLength":200,"nullable":true,"description":"The customer's name"},"external_id":{"type":"string","maxLength":200,"nullable":true,"description":"Your id for them; unique per account"},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Up to 50 string values"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"create_link","title":"Create link","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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"create_link_domain","title":"Create link domain","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"create_list","title":"Create list","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","maxLength":200,"nullable":true,"description":"What the list is for"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"create_number_pool","title":"Create number pool","description":"Create a sender pool from numbers you own.","inputSchema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","maxLength":64,"description":"Pool name"},"description":{"type":"string","maxLength":280,"description":"What the pool is for"},"routing":{"type":"string","enum":["sticky","local"],"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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"create_registration","title":"Create registration","description":"Create a 10DLC registration (the carrier registration local numbers need to text the public) and check it: the website, privacy policy, terms, opt-in page and example texts against carrier rules. Returns ready or checks_failed, with each finding, its fix and copy to paste. Nothing goes to the carriers and nothing is billed. Business details come from the person, not from guesses.","inputSchema":{"type":"object","required":["business_name","website","use_case"],"properties":{"business_name":{"type":"string","maxLength":120,"description":"The name customers know the business by, as the texts will name it."},"website":{"type":"string","format":"uri","description":"The business's own website. Reviewers visit it to confirm the business is real."},"use_case":{"type":"string","description":"What the texts are for. marketing and mixed need an opt-in for each person.","enum":["2fa","account_notification","customer_care","delivery_notification","fraud_alert","higher_education","marketing","mixed","polling_voting","public_service_announcement","security_alert","low_volume"]},"opt_in_url":{"type":"string","format":"uri","description":"Page where people enter their number"},"opt_in_screenshot_url":{"type":"string","format":"uri","nullable":true,"description":"People opt in inside an app: a public link to an image of that screen. Checked in place of a phone field and filed with the opt-in. null clears it."},"privacy_url":{"type":"string","format":"uri","description":"Discovered from homepage links when omitted"},"terms_url":{"type":"string","format":"uri","description":"Discovered from homepage links when omitted"},"support_email":{"type":"string","format":"email","description":"Used in the generated HELP reply"},"sample_messages":{"type":"array","nullable":true,"minItems":2,"maxItems":5,"items":{"type":"string","minLength":20,"maxLength":320},"description":"Real examples of the texts you will send, as a recipient would get them (no template variables). Carriers compare them with your traffic. Each must name your business; marketing and mixed use cases need opt-out wording in at least one. More than 5, or one over 320 characters, is a 400; too few or too short comes back as findings. Omit to get starter drafts; null or [] goes back to them."},"starter_messages":{"type":"array","nullable":true,"maxItems":5,"items":{"type":"string","maxLength":320},"description":"Draft examples suggested for this business (fields.sample_messages from POST /registrations/prefill). Shown instead of the template starter drafts; samples_source stays starter and they are never filed until you edit or confirm them. Drafts that would not pass the example check for the business name and use case are ignored."},"samples_confirmed":{"type":"boolean","description":"true = the starter drafts are right as they are; they become your examples. Ignored when sample_messages is sent."},"description":{"type":"string","nullable":true,"maxLength":500,"description":"What you send and to whom (40 to 500 characters). Omit or null to file the generated one."},"opt_in_flow":{"type":"string","nullable":true,"minLength":40,"maxLength":500,"description":"How people opt in, in your own words. It leads the filed opt-in account; the opt-in page, the disclosure and the START keyword are added after it. Omit or null to file the standard sentence."},"stop_reply":{"type":"string","nullable":true,"minLength":20,"maxLength":320,"description":"Your wording of the confirmation sent when someone opts out. It must name your business, say they are unsubscribed, and carry no link; anything else is a 400 naming what is missing. Omit or null for the standard wording in your business name. Filed with the registration and sent by its numbers."},"help_reply":{"type":"string","nullable":true,"minLength":20,"maxLength":320,"description":"Your wording of the HELP reply. It must name your business, give a way to reach you (email, phone or web page) and keep the STOP instruction. Omit or null for the standard wording."},"includes_links":{"type":"boolean","description":"Your messages include web links. Also true whenever an example contains one."},"includes_phone_numbers":{"type":"boolean","description":"Your messages include phone numbers. Also true whenever an example contains one."},"age_gated":{"type":"boolean","description":"Your messages are for adults only (alcohol, cannabis, gambling)."},"direct_lending":{"type":"boolean","description":"Your messages are about loans you make yourself."},"brand":{"type":"object","properties":{"legal_name":{"type":"string","description":"The legal name exactly as on the IRS EIN letter. Not needed for SOLE_PROPRIETOR."},"entity_type":{"type":"string","enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"description":"SOLE_PROPRIETOR needs no EIN, legal name or title: send contact_name, contact_email and contact_phone (their mobile). One number on the registration, and after submitting they enter the code texted to that mobile."},"ein":{"type":"string","description":"The EIN, matching the legal name. Not sent for SOLE_PROPRIETOR."},"street":{"type":"string","description":"Street address, not a P.O. box."},"city":{"type":"string","description":"City."},"state":{"type":"string","description":"2-letter US state or territory code."},"postal_code":{"type":"string","description":"5-digit ZIP, optionally ZIP+4."},"country":{"type":"string","description":"US only."},"vertical":{"type":"string","description":"The industry the business is in, like REAL_ESTATE, HEALTHCARE or RETAIL."},"contact_name":{"type":"string","description":"The authorized representative: a person who works for the business and can act for it. Required to submit. Kept with the registration for business verification; not sent to the registry."},"contact_title":{"type":"string","description":"The representative's job title, like Owner or Operations Manager. Required to submit."},"contact_email":{"type":"string","description":"The representative's own email at the business's domain. A free mailbox (gmail.com, outlook.com, ...) or a shared inbox (info@, sales@, support@, ...) is refused with 400 (param brand.contact_email). Carriers verify the business by writing to it."},"contact_phone":{"type":"string","description":"A 10-digit US number the representative answers. Required to submit: the carrier registry refuses a brand without one."},"stock_symbol":{"type":"string","description":"PUBLIC_PROFIT only, and then required to submit: the stock ticker, like ACME or BRK.B (up to 10 letters, digits, dots or dashes)."},"stock_exchange":{"type":"string","enum":["NASDAQ","NYSE","AMEX","TSX","LON","AMX","ASX","B3","BME","BSE","BZX","FRA","ICEX","JPX","JSE","KRX","NSE","NNQS","OMX","SEHK","SGX","SSE","STO","SWX","SZSE","TWSE","VSE","XPAR","XAMS","XMIL","XCSE","XBRU","XMAD","XOSL","XWAR","XETR","XSTU","XBER","XMUN","XHAM","XHAN","XDUS","XEUR","OTHER"],"description":"PUBLIC_PROFIT only, and then required to submit: the exchange the stock trades on."}},"description":"The business as the carriers register it. street must be a street address, not a P.O. box; state a 2-letter US state or territory code; postal_code a 5-digit ZIP (optionally +4). Anything else is refused with 400 naming the field."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"create_schedule","title":"Create schedule","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"},"from":{"type":"string","description":"One of your numbers. Optional when the account has exactly one number for the key's mode."},"body":{"type":"string","maxLength":1600,"description":"The text sent each time"},"repeat":{"type":"object","required":["frequency","time","timezone"],"properties":{"frequency":{"type":"string","enum":["daily","weekly","monthly"],"description":"How often it sends"},"time":{"type":"string","description":"24-hour wall-clock time, HH:MM, in `timezone`."},"timezone":{"type":"string","description":"IANA time zone."},"days_of_week":{"type":"array","items":{"type":"string","enum":["sun","mon","tue","wed","thu","fri","sat"]},"description":"Weekly only, required: which weekdays."},"day_of_month":{"type":"integer","minimum":1,"maximum":31,"description":"Monthly only, required. Months without that day run on their last day."}},"description":"When it sends: how often, the local time and the time zone"},"start_date":{"type":"string","format":"date","nullable":true,"description":"First local date it may run. Defaults to today."},"end_date":{"type":"string","format":"date","nullable":true,"description":"Last local date it may run (inclusive)."},"max_occurrences":{"type":"integer","minimum":1,"nullable":true,"description":"The schedule completes after this many messages have been sent."},"category":{"type":"string","nullable":true,"enum":["marketing","transactional","otp"],"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))."},"quiet_hours":{"type":"string","nullable":true,"enum":["block","defer"],"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 9: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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"create_segment","title":"Create segment","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"},"description":{"type":"string","maxLength":200,"nullable":true,"description":"What the segment is for"},"match":{"type":"string","enum":["all","any"],"default":"all","description":"all: a contact must match every rule. any: at least one rule"},"rules":{"type":"array","maxItems":10,"items":{"type":"object","required":["field"],"properties":{"field":{"type":"string","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"],"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)."},"key":{"type":"string","description":"The custom field name (field), topic id (topic), batch id (batch), or event name (event)"},"op":{"type":"string","enum":["is","is_not","contains","not_contains","exists","not_exists","before","after"],"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."},"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."}}},"description":"Up to 10 rules that decide who matches"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"create_template","title":"Create template","description":"Save a message template. Merge tags: {{first_name}}, {{name}}, {{phone}}, {{field:<custom>}}, and per-recipient variables.","inputSchema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","maxLength":60,"description":"Template name"},"body":{"type":"string","maxLength":1600,"description":"The message text, with merge tags"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"create_toll_free_verification","title":"Create toll free verification","description":"Start the carriers' toll-free verification for live toll-free numbers, filled in from the account, its registration, hosted opt-in page and website; any field sent replaces what was filled in. Returns a draft with problems: what the carriers would reject. Nothing goes to the carriers and there is no fee. Submitting needs a paid account (the free credit does not count); otherwise point the person to a local number with 10DLC registration.","inputSchema":{"type":"object","properties":{"numbers":{"type":"array","items":{"type":"string"},"description":"Your live toll-free numbers this program texts from, E.164. One per business unless multiple_numbers_reason says why."},"multiple_numbers_reason":{"type":"string","description":"Why the program needs more than one number (one per store, say). Required with more than one number."},"business_name":{"type":"string","description":"The legal name, as on the IRS EIN letter, optionally with \"d/b/a\" and the brand your messages carry."},"ein":{"type":"string","description":"The EIN (US), matching the legal name; elsewhere the business registration number."},"entity_type":{"type":"string","description":"The kind of business.","enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"]},"street":{"type":"string","description":"Street address of the business."},"city":{"type":"string","description":"City."},"state":{"type":"string","description":"State or province code."},"postal_code":{"type":"string","description":"ZIP or postal code."},"country":{"type":"string","description":"Country of the business."},"contact_first_name":{"type":"string","description":"First name of the person the carriers can contact about this program."},"contact_last_name":{"type":"string","description":"Their last name."},"contact_phone":{"type":"string","description":"A phone number they answer."},"brand_email":{"type":"string","description":"The business's own email, for its customers: the HELP reply and the hosted opt-in page name it."},"website":{"type":"string","format":"uri","description":"The business's website."},"use_case":{"type":"string","description":"What the texts are for.","enum":["2fa","account_notification","customer_care","delivery_notification","fraud_alert","higher_education","marketing","mixed","polling_voting","public_service_announcement","security_alert","low_volume"]},"use_case_summary":{"type":"string","maxLength":1500,"description":"What the program sends, to whom and why. At least 40 characters."},"sample_messages":{"type":"array","maxItems":8,"items":{"type":"string","maxLength":640},"description":"At least two example messages."},"help_reply":{"type":"string","description":"The reply to HELP: names the business and how to reach it. Omit to keep ours."},"stop_reply":{"type":"string","description":"The reply to STOP: names the business and says they are unsubscribed. Omit to keep ours."},"opt_in_description":{"type":"string","maxLength":2000,"description":"How people opt in, step by step. At least 40 characters."},"opt_in_url":{"type":"string","format":"uri","description":"The opt-in page. With none of your own we make you a hosted one."},"opt_in_screenshot_url":{"type":"string","format":"uri","description":"A public image of the step where people enter their number and agree. Needed when the opt-in page itself has no phone field, like a later step of a form or an app."},"monthly_volume":{"type":"string","description":"How many texts a month this program sends."},"volume_basis":{"type":"string","enum":["existing","projecting"],"description":"existing: what it sends today. projecting: an estimate."},"advertising":{"type":"string","enum":["yes","no","unsure"],"description":"Whether the messages advertise a product or service."},"previous_service":{"type":"string","enum":["new","short_code","long_number"],"description":"Where this traffic ran before."},"previous_content":{"type":"string","maxLength":2000,"description":"Sample messages from the previous service (not new only)."},"previous_numbers":{"type":"string","description":"The numbers it used (not new only)."},"number_published":{"type":"string","description":"Where people see this number."},"fortune_500":{"type":"boolean","description":"The company is in the Fortune 500."},"urls_in_messages":{"type":"string","description":"Links your messages include, or \"None\"."},"phones_in_messages":{"type":"string","description":"Phone numbers your messages include, or \"None\"."},"terms_url":{"type":"string","format":"uri","description":"The terms page, with the SMS program terms."},"privacy_url":{"type":"string","format":"uri","description":"The privacy policy page."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"create_topic","title":"Create topic","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","maxLength":200,"nullable":true,"description":"What the topic covers"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"create_webhook","title":"Create webhook","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":{"description":"Event types to receive. Omit, or send \"*\" or [], for every event. An unknown type is a 400.","oneOf":[{"type":"string","enum":["*"]},{"type":"array","items":{"type":"string"}}]},"description":{"type":"string","maxLength":120,"description":"A note on what the endpoint is for"},"numbers":{"type":"array","maxItems":100,"items":{"type":"string"},"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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"delete_automation","title":"Delete automation","description":"Delete an automation.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Automation id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"delete_contact","title":"Delete contact","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"delete_customer","title":"Delete customer","description":"Delete a customer.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Customer id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"delete_link_domain","title":"Delete link domain","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"delete_list","title":"Delete list","description":"Delete a list (its contacts stay).","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"List id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"delete_message","title":"Delete message","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_...)"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"delete_number_pool","title":"Delete number pool","description":"Delete a sender pool. Its numbers are kept.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Pool id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"delete_schedule","title":"Delete schedule","description":"Delete a recurring schedule.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Schedule id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"delete_segment","title":"Delete segment","description":"Delete a segment. Contacts are not touched.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Segment id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"delete_template","title":"Delete template","description":"Delete a template.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Template id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"delete_topic","title":"Delete topic","description":"Delete a topic you created (built-in topics stay).","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Topic id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"delete_webhook","title":"Delete webhook","description":"Delete a webhook endpoint.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Webhook endpoint id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"disconnect_integration","title":"Disconnect integration","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"enter_registration_phone_code","title":"Enter registration phone code","description":"A sole proprietor's registration: the code texted to their mobile after submitting (it lasts 24 hours). The right code sends the campaign to carrier review. The person reads it from their phone.","inputSchema":{"type":"object","required":["id","code"],"properties":{"id":{"type":"string","description":"Registration id (reg_...)"},"code":{"type":"string","description":"The code from the text sent to the sole proprietor's mobile."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"export_consent","title":"Export consent","description":"The suppression list, or the full consent ledger with opt-in proof, as CSV text.","inputSchema":{"type":"object","properties":{"type":{"type":"string","enum":["suppressions","ledger"],"default":"suppressions","description":"suppressions: the opted-out numbers. ledger: every consent record, with proof"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"export_csv","title":"Export csv","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":{"kind":{"type":"string","description":"messages, deliveries, events, opt_outs, webhook_deliveries, usage, usage_monthly, audit_log or credit_history"},"from":{"type":"string","description":"ISO date/time or epoch ms (messages, deliveries, events, webhook_deliveries)"},"to":{"type":"string","description":"Inclusive; a bare date means the end of that day (UTC)"},"status":{"type":"string","enum":["queued","sent","delivered","failed","blocked","received"],"description":"messages, deliveries"},"blocked_reason":{"type":"string","description":"messages, deliveries: blocked messages with this reason"},"direction":{"type":"string","enum":["outbound","inbound"],"description":"messages"},"number":{"type":"string","description":"messages, deliveries: digits matched against either side"},"to_number":{"type":"string","description":"messages, deliveries: exact recipient (E.164). `to`/`from` are the date range here."},"from_number":{"type":"string","description":"messages, deliveries: exact sender (E.164)"},"customer_id":{"type":"string","description":"messages, deliveries"},"failure_code":{"type":"string","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"],"description":"messages, deliveries: failed for this reason (the `failure.code` on a message)"},"batch":{"type":"string","description":"messages, deliveries: batch id (bc_...)"},"q":{"type":"string","description":"messages: body/failure text; events: id/payload text"},"type":{"type":"string","description":"events, webhook_deliveries"},"endpoint_id":{"type":"string","description":"webhook_deliveries (default: all endpoints)"},"ok":{"type":"boolean","description":"webhook_deliveries"},"months":{"type":"integer","minimum":1,"maximum":12,"default":3,"description":"usage: daily rows for the last N months"},"action":{"type":"string","description":"audit_log: one action, or a group prefix with a trailing dot (team.)"},"actor":{"type":"string","description":"audit_log: actor id or part of the actor email"},"target_type":{"type":"string","description":"audit_log"},"created_after":{"type":"string","description":"audit_log: same as on GET /audit-logs (from is accepted too)"},"created_before":{"type":"string","description":"audit_log: same as on GET /audit-logs (to is accepted too)"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"export_numbers","title":"Export numbers","description":"Your numbers as CSV text.","inputSchema":{"type":"object","properties":{"tag":{"type":"string","description":"Only numbers with this tag"},"pool":{"type":"string","description":"Pool id"},"mode":{"type":"string","enum":["test","live"],"description":"test for sandbox numbers, live for real ones"},"q":{"type":"string","description":"Matches digits of the number or its label"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"fallback_verification","title":"Fallback verification","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":{"type":"string","enum":["email"],"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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"forget_identity","title":"Forget identity","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"get_automation","title":"Get automation","description":"Retrieve an automation with its trigger and steps.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Automation id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_automation_run","title":"Get automation run","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"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_balance","title":"Get balance","description":"Prepaid credit balance and auto-recharge setting.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_batch","title":"Get batch","description":"Retrieve a batch with its progress counts.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Batch id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_batch_results","title":"Get batch results","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"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_consent","title":"Get consent","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"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_contact","title":"Get contact","description":"Retrieve a contact.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Contact id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_contact_topics","title":"Get contact topics","description":"A contact's subscription to each topic.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Contact id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_customer","title":"Get customer","description":"Retrieve a customer.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Customer id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_customer_usage","title":"Get customer usage","description":"A customer's messages, verifications and spend for a period.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Customer id"},"start":{"type":"string","format":"date","description":"Default: first day of this month"},"end":{"type":"string","format":"date","description":"Default: today"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_deliverability","title":"Get deliverability","description":"Delivery rates by day, destination carrier, or sending number.","inputSchema":{"type":"object","properties":{"group_by":{"type":"string","enum":["day","carrier","number"],"description":"What to group the rates by"},"start_date":{"type":"string","description":"YYYY-MM-DD"},"end_date":{"type":"string","description":"YYYY-MM-DD"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_integration","title":"Get integration","description":"One connected tool and its last sync.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Integration id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_integration_events","title":"Get integration events","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."}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_link_domain","title":"Get link domain","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_...)"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_list","title":"Get list","description":"Retrieve a list and its contact count.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"List id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_message","title":"Get message","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_...)"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_number","title":"Get number","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"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_number_pool","title":"Get number pool","description":"Retrieve a sender pool and its numbers.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Pool id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_registration","title":"Get registration","description":"A registration with its checks, status, and linked numbers.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Registration id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_schedule","title":"Get schedule","description":"Retrieve a recurring schedule with its recent occurrences.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Schedule id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_scheduled_message","title":"Get scheduled message","description":"Retrieve a pending scheduled message.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Scheduled message id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_segment","title":"Get segment","description":"Retrieve a segment and its rules.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Segment id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_spend_limit","title":"Get spend limit","description":"The monthly spend limit and this month's estimated spend.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_template","title":"Get template","description":"Retrieve a template.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Template id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_toll_free_verification","title":"Get toll free verification","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_...)"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_topic","title":"Get topic","description":"Retrieve a topic.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Topic id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_usage","title":"Get usage","description":"Usage by month, today's counters, and plan limits.","inputSchema":{"type":"object","properties":{"months":{"type":"number","description":"How many months back (default 3)"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_verification","title":"Get verification","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"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"get_webhook","title":"Get webhook","description":"Retrieve a webhook endpoint.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Webhook endpoint id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"import_contacts","title":"Import contacts","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":{"contacts":{"type":"array","maxItems":500,"items":{"type":"object","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"E.164, US or Canada"},"name":{"type":"string","maxLength":120,"description":"Display name. Defaults to first + last name."},"tags":{"type":"array","maxItems":20,"items":{"type":"string","maxLength":40},"description":"Labels that group contacts"},"fields":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 string values (account id, plan, location...), usable in segments and as {{field:key}} merge fields"},"notes":{"type":"string","maxLength":2000,"description":"Free-text notes"},"first_name":{"type":"string","maxLength":80,"description":"First name"},"last_name":{"type":"string","maxLength":80,"description":"Last name"},"email":{"type":"string","maxLength":254,"description":"Email address"},"company":{"type":"string","maxLength":120,"description":"Company name"},"state":{"type":"string","maxLength":40,"description":"US state or Canadian province, usually a 2-letter code"},"source":{"type":"string","maxLength":60,"description":"Where the contact came from. Defaults to \"api\"."},"opt_in":{"type":"object","description":"Import only (POST /v1/contacts/import). Stored as consent evidence; never lifts an opt-out.","properties":{"status":{"type":"boolean","description":"true = opted in; false = unsubscribed (recorded as an opt-out)"},"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"},"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"},"page_url":{"type":"string","format":"uri","description":"The page a web-form opt-in was collected on"}}}}},"description":"Contacts to create or update, up to 500 per call"},"campaign_id":{"type":"string","description":"Applies to every opt_in row that does not name its own campaign_id"},"dry_run":{"type":"boolean","description":"true returns what would change and writes nothing"},"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."},"import_id":{"type":"string","description":"From a previous response, to group several requests as one import."},"name":{"type":"string","description":"A label for the import (first request only)."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"import_opt_outs","title":"Import opt outs","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"link_number_to_registration","title":"Link number to registration","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_...)"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"list_api_keys","title":"List api keys","description":"List the active API keys of this mode (never the secrets).","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_audit_logs","title":"List audit logs","description":"Who changed what on the account (keys, team, webhooks, spend limit, numbers, consent, settings), newest first.","inputSchema":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":100,"default":25,"description":"Max results (default 25, max 100)"},"cursor":{"type":"string","description":"next_cursor from the previous page"},"action":{"type":"string","description":"One action, or a group prefix with a trailing dot (team., api_key.)"},"actor":{"type":"string","description":"Actor id (exact) or part of the actor email (case-insensitive)"},"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)"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_automation_runs","title":"List automation runs","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"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_automations","title":"List automations","description":"List automations.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_batch_recipients","title":"List batch recipients","description":"List a batch's recipients with each one's status.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Batch id"},"status":{"type":"string","enum":["queued","paused","sent","failed","skipped","canceled"],"description":"Only recipients with this status"},"limit":{"type":"number","description":"Max results (default 25, max 100)"},"cursor":{"type":"string","description":"next_cursor from the previous page"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_batches","title":"List batches","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":{"type":"string","enum":["scheduled","sending","paused","complete","canceled"],"description":"Only batches with this status"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_contacts","title":"List contacts","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":{"limit":{"type":"number","description":"Max results (default 25, max 100)"},"cursor":{"type":"string","description":"next_cursor from the previous page"},"tag":{"type":"string","description":"Only contacts with this tag"},"phone_number":{"type":"string","description":"E.164"},"segment_id":{"type":"string","description":"Only contacts in this segment"},"list_id":{"type":"string","description":"Only contacts in this list"},"q":{"type":"string","description":"Search text"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_conversions","title":"List conversions","description":"The latest 100 conversions, newest first.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_customers","title":"List customers","description":"List your customers.","inputSchema":{"type":"object","properties":{"limit":{"type":"integer","maximum":100,"default":25,"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)"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_events","title":"List events","description":"List recent events (message.sent/delivered/failed/received, number.purchased/released, ...), 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"},"type":{"type":"string","description":"Only events of this type, like message.delivered"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_integrations","title":"List integrations","description":"The connected tools: status, settings, last sync (found, added, opted out), and their list. No credentials.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_link_domains","title":"List link domains","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":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_links","title":"List links","description":"Every tracked destination with its texts, clicks, conversions and value. The answer to \"which link worked?\".","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_list_contacts","title":"List list contacts","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","minimum":1,"maximum":100,"default":25,"description":"Max results (default 25, max 100)"},"cursor":{"type":"string","description":"next_cursor from the previous page"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_lists","title":"List lists","description":"List contact lists with their contact counts.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_messages","title":"List messages","description":"List your messages, newest first. Filter by number, direction, status, failure reason, date, batch schedule or customer.","inputSchema":{"type":"object","properties":{"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"},"to":{"type":"string","description":"Exact destination number (E.164)"},"from":{"type":"string","description":"Exact sending number (E.164)"},"status":{"type":"string","enum":["queued","sent","delivered","failed","blocked","received"],"description":"Only messages with this status"},"blocked_reason":{"type":"string","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"],"description":"Blocked messages with this reason. Implies status=blocked."},"failure_code":{"type":"string","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"],"description":"Filter to messages that failed for this reason (the `failure.code` on a message)"},"direction":{"type":"string","enum":["outbound","inbound"],"description":"outbound (sent) or inbound (received)"},"created_after":{"type":"string","description":"Inclusive. ISO timestamp or epoch ms."},"created_before":{"type":"string","description":"Exclusive. ISO timestamp or epoch ms."},"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_...)"},"tag":{"type":"string","description":"Filter to messages sent with this tag"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_number_pools","title":"List number pools","description":"List sender pools.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_number_requests","title":"List number requests","description":"Open short-code and toll-free requests.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_numbers","title":"List numbers","description":"List the phone numbers on your account.","inputSchema":{"type":"object","properties":{"customer_id":{"type":"string","description":"Only this customer's numbers"},"tag":{"type":"string","description":"Only numbers with this tag"},"pool":{"type":"string","description":"Pool id"},"mode":{"type":"string","enum":["test","live"],"description":"test for sandbox numbers, live for real ones"},"q":{"type":"string","description":"Matches digits of the number or its label"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_opt_outs","title":"List opt outs","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"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_registration_submissions","title":"List registration submissions","description":"The filed copies of a 10DLC registration, newest first.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Registration id"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_registrations","title":"List registrations","description":"List 10DLC brand and campaign registrations and their status. Marketing from a local number needs an approved one.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_scheduled_messages","title":"List scheduled messages","description":"List single messages scheduled for later and not yet sent.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_schedules","title":"List schedules","description":"List recurring schedules.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_segments","title":"List segments","description":"List saved segments.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_templates","title":"List templates","description":"List message templates.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_toll_free_verifications","title":"List toll free verifications","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":{"status":{"type":"string","enum":["draft","in_review","submitted","verified","rejected"],"description":"Only verifications with this status"},"limit":{"type":"integer","minimum":1,"maximum":100,"default":25,"description":"Max results (default 25, max 100)"},"cursor":{"type":"string","description":"next_cursor from the previous page"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_topics","title":"List topics","description":"List subscription topics.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_webhook_deliveries","title":"List webhook deliveries","description":"Delivery attempts to your webhook endpoints, with response status codes.","inputSchema":{"type":"object","properties":{"endpoint_id":{"type":"string","description":"One endpoint (we_...), or status_callback for the attempts to send messages' own status callbacks."},"event_id":{"type":"string","description":"Every attempt for one event"},"limit":{"type":"number","description":"Max results (default 25, max 100)"},"cursor":{"type":"string","description":"next_cursor from the previous page"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_webhooks","title":"List webhooks","description":"List webhook endpoints.","inputSchema":{"type":"object","properties":{}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"lookup_phone","title":"Lookup phone","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"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":true}},{"name":"pause_automation","title":"Pause automation","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"pause_batch","title":"Pause batch","description":"Pause a sending or scheduled batch.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Batch id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"plan_campaign","title":"Plan campaign","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, right away or optimal user time, the event that ends it, follow-ups, repeats, who gets it, the message, link, sender and topic. kind broadcast: audience, who to leave out, message, when, sender, topic, follow-up. Also who never gets the text (exclusions) and what is missing (gaps). Changes nothing.","inputSchema":{"type":"object","properties":{"kind":{"type":"string","enum":["automation","broadcast"],"default":"automation","description":"automation (texts started by an event) or broadcast (one send to an audience)."}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"plan_import","title":"Plan import","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."}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"plan_task","title":"Plan task","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 for carrier filings (what only the person can accept or sign). 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."}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"prefill_registration","title":"Prefill registration","description":"Suggest a 10DLC registration from a business website: business and legal name, use case, description, opt-in, privacy and terms pages (ranked candidates), support email and draft example texts. Reads public pages only and changes nothing. The suggestions are guesses for the person to confirm.","inputSchema":{"type":"object","required":["website"],"properties":{"website":{"type":"string","format":"uri","description":"The business's website to read."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"preview_automation","title":"Preview automation","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, merge fields that would come out empty, and, for an optimal-user-time step with `to`, next_send: when it would go for that person and why.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Automation id"},"properties":{"type":"object","additionalProperties":true,"description":"Sample event properties for merge fields, e.g. {\"plan\": \"pro\"}"},"to":{"type":"string","description":"E.164. Fills contact merge fields and shows when an optimal-user-time text would go for this person"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"preview_segment","title":"Preview segment","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"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"purchase_number","title":"Purchase number","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":{"phone_number":{"type":"string","description":"The number to buy, in E.164"},"customer_id":{"type":"string","description":"Optional: assign the number to one of your customers"},"registration_id":{"type":"string","description":"Optional (live numbers): the registration this number should send for. Without it the number follows your account's registration."},"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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"query_audience","title":"Query audience","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":{"match":{"type":"string","enum":["all","any"],"default":"all","description":"all: a contact must match every rule. any: at least one rule"},"rules":{"type":"array","maxItems":10,"items":{"type":"object","required":["field"],"properties":{"field":{"type":"string","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"],"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)."},"key":{"type":"string","description":"The custom field name (field), topic id (topic), batch id (batch), or event name (event)"},"op":{"type":"string","enum":["is","is_not","contains","not_contains","exists","not_exists","before","after"],"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."},"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."}}},"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"},"limit":{"type":"integer","minimum":0,"maximum":100,"default":25,"description":"How many matching contacts to return"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"recheck_registration","title":"Recheck registration","description":"Correct a registration and run its checks again (draft, checks_failed, ready or rejected). Send any field to change it; after fixing the website, this re-reads it. Returns the new status and findings.","inputSchema":{"type":"object","required":["id","business_name","website","use_case"],"properties":{"id":{"type":"string","description":"Registration id (reg_...)"},"business_name":{"type":"string","maxLength":120,"description":"The name customers know the business by, as the texts will name it."},"website":{"type":"string","format":"uri","description":"The business's own website. Reviewers visit it to confirm the business is real."},"use_case":{"type":"string","description":"What the texts are for. marketing and mixed need an opt-in for each person.","enum":["2fa","account_notification","customer_care","delivery_notification","fraud_alert","higher_education","marketing","mixed","polling_voting","public_service_announcement","security_alert","low_volume"]},"opt_in_url":{"type":"string","format":"uri","description":"Page where people enter their number"},"opt_in_screenshot_url":{"type":"string","format":"uri","nullable":true,"description":"People opt in inside an app: a public link to an image of that screen. Checked in place of a phone field and filed with the opt-in. null clears it."},"privacy_url":{"type":"string","format":"uri","description":"Discovered from homepage links when omitted"},"terms_url":{"type":"string","format":"uri","description":"Discovered from homepage links when omitted"},"support_email":{"type":"string","format":"email","description":"Used in the generated HELP reply"},"sample_messages":{"type":"array","nullable":true,"minItems":2,"maxItems":5,"items":{"type":"string","minLength":20,"maxLength":320},"description":"Real examples of the texts you will send, as a recipient would get them (no template variables). Carriers compare them with your traffic. Each must name your business; marketing and mixed use cases need opt-out wording in at least one. More than 5, or one over 320 characters, is a 400; too few or too short comes back as findings. Omit to get starter drafts; null or [] goes back to them."},"starter_messages":{"type":"array","nullable":true,"maxItems":5,"items":{"type":"string","maxLength":320},"description":"Draft examples suggested for this business (fields.sample_messages from POST /registrations/prefill). Shown instead of the template starter drafts; samples_source stays starter and they are never filed until you edit or confirm them. Drafts that would not pass the example check for the business name and use case are ignored."},"samples_confirmed":{"type":"boolean","description":"true = the starter drafts are right as they are; they become your examples. Ignored when sample_messages is sent."},"description":{"type":"string","nullable":true,"maxLength":500,"description":"What you send and to whom (40 to 500 characters). Omit or null to file the generated one."},"opt_in_flow":{"type":"string","nullable":true,"minLength":40,"maxLength":500,"description":"How people opt in, in your own words. It leads the filed opt-in account; the opt-in page, the disclosure and the START keyword are added after it. Omit or null to file the standard sentence."},"stop_reply":{"type":"string","nullable":true,"minLength":20,"maxLength":320,"description":"Your wording of the confirmation sent when someone opts out. It must name your business, say they are unsubscribed, and carry no link; anything else is a 400 naming what is missing. Omit or null for the standard wording in your business name. Filed with the registration and sent by its numbers."},"help_reply":{"type":"string","nullable":true,"minLength":20,"maxLength":320,"description":"Your wording of the HELP reply. It must name your business, give a way to reach you (email, phone or web page) and keep the STOP instruction. Omit or null for the standard wording."},"includes_links":{"type":"boolean","description":"Your messages include web links. Also true whenever an example contains one."},"includes_phone_numbers":{"type":"boolean","description":"Your messages include phone numbers. Also true whenever an example contains one."},"age_gated":{"type":"boolean","description":"Your messages are for adults only (alcohol, cannabis, gambling)."},"direct_lending":{"type":"boolean","description":"Your messages are about loans you make yourself."},"brand":{"type":"object","properties":{"legal_name":{"type":"string","description":"The legal name exactly as on the IRS EIN letter. Not needed for SOLE_PROPRIETOR."},"entity_type":{"type":"string","enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"description":"SOLE_PROPRIETOR needs no EIN, legal name or title: send contact_name, contact_email and contact_phone (their mobile). One number on the registration, and after submitting they enter the code texted to that mobile."},"ein":{"type":"string","description":"The EIN, matching the legal name. Not sent for SOLE_PROPRIETOR."},"street":{"type":"string","description":"Street address, not a P.O. box."},"city":{"type":"string","description":"City."},"state":{"type":"string","description":"2-letter US state or territory code."},"postal_code":{"type":"string","description":"5-digit ZIP, optionally ZIP+4."},"country":{"type":"string","description":"US only."},"vertical":{"type":"string","description":"The industry the business is in, like REAL_ESTATE, HEALTHCARE or RETAIL."},"contact_name":{"type":"string","description":"The authorized representative: a person who works for the business and can act for it. Required to submit. Kept with the registration for business verification; not sent to the registry."},"contact_title":{"type":"string","description":"The representative's job title, like Owner or Operations Manager. Required to submit."},"contact_email":{"type":"string","description":"The representative's own email at the business's domain. A free mailbox (gmail.com, outlook.com, ...) or a shared inbox (info@, sales@, support@, ...) is refused with 400 (param brand.contact_email). Carriers verify the business by writing to it."},"contact_phone":{"type":"string","description":"A 10-digit US number the representative answers. Required to submit: the carrier registry refuses a brand without one."},"stock_symbol":{"type":"string","description":"PUBLIC_PROFIT only, and then required to submit: the stock ticker, like ACME or BRK.B (up to 10 letters, digits, dots or dashes)."},"stock_exchange":{"type":"string","enum":["NASDAQ","NYSE","AMEX","TSX","LON","AMX","ASX","B3","BME","BSE","BZX","FRA","ICEX","JPX","JSE","KRX","NSE","NNQS","OMX","SEHK","SGX","SSE","STO","SWX","SZSE","TWSE","VSE","XPAR","XAMS","XMIL","XCSE","XBRU","XMAD","XOSL","XWAR","XETR","XSTU","XBER","XMUN","XHAM","XHAN","XDUS","XEUR","OTHER"],"description":"PUBLIC_PROFIT only, and then required to submit: the exchange the stock trades on."}},"description":"The business as the carriers register it. street must be a street address, not a P.O. box; state a 2-letter US state or territory code; postal_code a 5-digit ZIP (optionally +4). Anything else is refused with 400 naming the field."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"recommend_message","title":"Recommend message","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","properties":{"industry":{"type":"string","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"],"description":"The sender's industry"},"company_type":{"type":"string","enum":["ecommerce","subscription_ecommerce","subscription_app","consumer_app","restaurant","hospitality","retail","marketplace","fintech","services"],"description":"Kind of business"},"goal":{"type":"string","enum":["any","abandoned_cart","abandoned_browse","welcome","winback","failed_payment","trial","promo","re_engagement","post_purchase","back_in_stock","quiz","launch","transactional","mixed"],"default":"any","description":"The message type to write, or `any` to compare the types that fit `audience`"},"audience":{"type":"string","description":"Who gets it, in words, e.g. \"opened the paywall and left\""},"brand":{"type":"string","maxLength":40,"description":"Business name as customers know it"},"product":{"type":"string","maxLength":60,"description":"What is being sold, as the customer would say it, e.g. \"your second number\""},"offer":{"type":"string","description":"Optional, e.g. \"50% off your first month\". Without one no candidate has an offer"},"code":{"type":"string","description":"Optional promo code"},"deadline":{"type":"string","description":"Optional, e.g. \"tonight\""},"link":{"type":"string","description":"URL or merge field; default {{link}}"},"first_name":{"type":"boolean","description":"Your contacts have first names, so candidates may use {{first_name}}"},"first_message":{"type":"boolean","description":"The first text these people get from the number: the brand and opt-out line are added and counted"},"candidates":{"type":"string","description":"Your own drafts to score: a JSON array of up to 10 strings"},"limit":{"type":"integer","minimum":1,"maximum":20,"default":5,"description":"How many messages to return (default 5, max 20)"},"use_history":{"type":"boolean","default":true,"description":"false ranks on the case studies only"}},"required":["industry","company_type","brand","product"]},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"record_conversion","title":"Record conversion","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":{"click_id":{"type":"string","description":"The `tk` value on the landing page URL."},"value_cents":{"type":"integer","minimum":0,"description":"Optional. What it was worth, in US cents."},"name":{"type":"string","maxLength":80,"description":"Optional. What happened, like purchase."},"external_id":{"type":"string","maxLength":128,"description":"Optional. Your id for it. The same id twice counts once and returns the first with 200."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"redact_message","title":"Redact message","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_...)"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"release_number","title":"Release number","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":true}},{"name":"remove_from_list","title":"Remove from list","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"replay_event","title":"Replay event","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_...)"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"replay_failed_webhooks","title":"Replay failed webhooks","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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"request_short_code","title":"Request short code","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":{"type":"string","enum":["short_code","toll_free"],"description":"short_code, or toll_free for a number our team sets up"},"business_name":{"type":"string","maxLength":120,"description":"The business the number is for"},"monthly_volume":{"type":"string","enum":["under_1k","1k_10k","10k_100k","over_100k"],"description":"Expected texts a month"},"use_case":{"type":"string","minLength":10,"maxLength":500,"description":"What you will send, in a sentence or two."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"resend_registration_phone_code","title":"Resend registration phone code","description":"Text a new code to a sole proprietor's mobile for their registration. The old code stops working. At most 5 codes per submission, one a minute.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Registration id (reg_...)"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"resume_batch","title":"Resume batch","description":"Resume a paused batch.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Batch id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"retry_batch","title":"Retry batch","description":"Retry a batch's failed recipients.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Batch id"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"revoke_api_key","title":"Revoke api key","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"rotate_webhook_secret","title":"Rotate webhook secret","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","minimum":0,"maximum":604800,"default":0,"description":"Seconds the old secret keeps signing alongside the new one."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"search_available_numbers","title":"Search available numbers","description":"Search purchasable numbers by area code (default 415).","inputSchema":{"type":"object","properties":{"area_code":{"type":"string","description":"Three-digit area code (default 415)"}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"send_batch","title":"Send batch","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. scheduled_at sends at one instant; send_at_local (like 2026-11-10T17:00) sends at that time on each person's own clock.no_opt_in (recipients the send will 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. Each recipient can carry external_id (their Mixpanel distinct_id) so the text's events land on their Mixpanel profile. With a live key it texts real people.","inputSchema":{"type":"object","required":["body"],"properties":{"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."},"body":{"type":"string","maxLength":1600,"description":"The message text. Merge tags fill per recipient"},"name":{"type":"string","maxLength":80,"description":"A name for the broadcast"},"recipients":{"type":"array","maxItems":10000,"items":{"type":"object","required":["to"],"properties":{"to":{"type":"string","description":"Recipient's number in E.164"},"variables":{"type":"object","additionalProperties":{"type":"string"},"description":"Merge values for this recipient, by name"},"external_id":{"type":"string","maxLength":255,"description":"Optional. The person's id in your analytics tool (their Mixpanel distinct_id; `mixpanel_distinct_id` is accepted too). With a Mixpanel integration connected, each event about this text lands on that profile in Mixpanel. Without it, the contact with this number that Mixpanel supplied is used."}}},"description":"Explicit recipients, up to 10,000"},"tags":{"type":"array","items":{"type":"string"},"description":"Send to contacts carrying any of these tags (instead of recipients)."},"contact_ids":{"type":"array","items":{"type":"string"},"description":"Send to these contacts, by id"},"segment_id":{"type":"string","description":"Send to the contacts in this saved segment, evaluated when the batch is created (instead of recipients)."},"list_id":{"type":"string","description":"Send to the contacts in this list, as it is when the batch is created (instead of recipients)."},"category":{"type":"string","enum":["marketing","transactional","otp"],"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."},"quiet_hours":{"type":"string","enum":["block","defer"],"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 9:00am. Omitted: each recipient in quiet hours is held until their 9:00am."},"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."},"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."},"scheduled_at":{"type":"string","description":"Future ISO timestamp or epoch ms, up to 30 days out."},"send_at_local":{"type":"string","description":"Instead of `scheduled_at`: a date and time with no time zone, up to 30 days out, sent at that time in each recipient's own zone, read from the area code. Refused if it has passed for any recipient. Quiet hours still hold a time outside the window."},"dry_run":{"type":"boolean","description":"Validate only: returns a BatchValidation and sends nothing."},"check_line_types":{"type":"boolean","description":"Reject landlines (first 500 unique numbers are checked)."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"send_message","title":"Send message","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 (narrower in some states) in the recipient's local time a marketing message is refused and anything else is held until 9am, except one-time codes and replies within 4 hours of their text. In sandbox (test keys), delivery is simulated: +15005550006 delivers, +15005550002 fails, +15005550007 is filtered as 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"},"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."},"body":{"type":"string","maxLength":1600,"description":"The message text"},"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)."},"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 9:00am; any other message is moved."},"category":{"type":"string","enum":["marketing","transactional","otp"],"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."},"quiet_hours":{"type":"string","enum":["block","defer"],"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 9:00am. Omitted: the account default (a single marketing send is refused; every other message is held). One-time codes are never held."},"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; texts are counted on the shortened body. Works with scheduled_at."},"tags":{"type":"array","maxItems":10,"items":{"type":"string","maxLength":32},"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=."},"consent":{"type":"object","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.","required":["source","collected_at"],"properties":{"source":{"type":"string","enum":["web_form","keyword","paper","checkout","verbal"],"description":"How the recipient agreed"},"collected_at":{"type":"string","description":"When they agreed: ISO timestamp or epoch ms, not in the future."},"page_url":{"type":"string","format":"uri","description":"Required for web_form: the page the form was on."}}},"media":{"type":"array","items":{"type":"string","format":"uri"},"description":"Reserved for MMS; currently returns 400 mms_not_enabled."},"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."},"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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"send_verification","title":"Send verification","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":{"channel":{"type":"string","enum":["sms","email"],"default":"sms","description":"How the code goes out. `sms` needs `phone`; `email` needs `email`."},"phone":{"type":"string","description":"The number to text the code to (channel `sms`). `to` works too."},"email":{"type":"string","description":"The address to email the code to (channel `email`). Disposable addresses are refused."},"app_name":{"type":"string","maxLength":24,"description":"Your product name, shown in the message"},"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."},"from":{"type":"string","description":"Optional, channel `sms` only: send from a number you own instead of the TextKit pool"},"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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"set_consent","title":"Set consent","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":{"phone":{"type":"string","description":"E.164 number"},"status":{"type":"string","enum":["opted_out","opted_in"],"description":"opted_in or opted_out"},"note":{"type":"string","maxLength":200,"description":"A note kept on the consent record"},"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."},"proof":{"type":"object","description":"Opt-in evidence (Messaging Policy 1.4). Accepted only with status opted_in.","required":["source"],"properties":{"source":{"type":"string","enum":["web_form","keyword","paper","checkout","verbal"],"description":"How the opt-in was collected"},"collected_at":{"type":"string","format":"date-time","description":"When the person consented; defaults to now"},"page_url":{"type":"string","format":"uri","description":"Required for web_form"},"disclosure":{"type":"string","maxLength":2000,"description":"Exact disclosure wording shown"},"ip":{"type":"string","description":"The person's IP address when they opted in"},"user_agent":{"type":"string","maxLength":500,"description":"The person's browser user agent when they opted in"},"registration_id":{"type":"string","description":"The registration the opt-in is for (reg_...)"},"campaign_id":{"type":"string","description":"The registration the opt-in is for (reg_...)"},"message_id":{"type":"string","description":"The inbound message that was the opt-in. Required for keyword opt-ins recorded for a marketing registration"}}}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"set_contact_topic","title":"Set contact topic","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)"},"subscribed":{"type":"boolean","description":"true subscribes the contact to the topic, false unsubscribes them"},"source":{"type":"string","description":"Where the change came from, e.g. \"preference_page\". Default \"api\"."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"set_spend_limit","title":"Set spend limit","description":"Set or remove the monthly spend cap and its alert thresholds. Live sends over the cap are refused.","inputSchema":{"type":"object","properties":{"monthly_limit_usd":{"type":"number","nullable":true,"minimum":1,"maximum":1000000,"description":"null removes the cap"},"alert_thresholds":{"type":"array","maxItems":5,"items":{"type":"integer","minimum":1,"maximum":100},"description":"Percentages of the limit to alert at, up to 5, like [50, 80, 100]"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"simulate_inbound","title":"Simulate inbound","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."},"from":{"type":"string","description":"Who the simulated text comes from, in E.164"},"body":{"type":"string","description":"The text of the simulated message"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"submit_registration","title":"Submit registration","description":"File a ready registration for carrier review, or resubmit one after a rejection. fees_acknowledged: true is the person's own acceptance of the carrier registration fees (separate from the per-text rate, a campaign billed for at least 3 months, non-refundable even if rejected); it is recorded with the time on the filed copy. The first submit for a business also carries the business attestation, signed by someone authorized to act for it, with the name they give. Both come from the person in this conversation. Our review can hold the filing for a person on our team; get the status afterwards.","inputSchema":{"type":"object","required":["id","fees_acknowledged"],"properties":{"id":{"type":"string","description":"Registration id (reg_...)"},"fees_acknowledged":{"type":"boolean","enum":[true],"description":"Must be true. Confirms the registration fee terms above."},"attestation":{"type":"object","required":["signer_name","signer_title","accepted"],"description":"Signed by someone authorized to act for the business, once per business: that they are authorized, that the details match the business's IRS records, and that the business will text only people who agreed to it and will follow the Messaging Policy. Kept as signed, with the exact wording, who sent it (the API key), the IP address, the user agent and the date of our legal documents.","properties":{"signer_name":{"type":"string","minLength":2,"maxLength":120,"description":"The full name of the person signing."},"signer_title":{"type":"string","minLength":2,"maxLength":120,"description":"Their job title."},"accepted":{"type":"boolean","description":"Must be true: the person signing agrees to the statement."}}}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"submit_toll_free_verification","title":"Submit toll free verification","description":"Send a draft, or a rejected form that was fixed, for review: it becomes in_review, we check it (usually within minutes) and then file it with the carriers (usually 4 to 5 business days). The first form for a business carries the business attestation, signed by someone authorized to act for it, with the name they give in this conversation. Answers with problems while anything the carriers require is missing. No fee.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Toll-free verification id (tfv_...)"},"attestation":{"type":"object","required":["signer_name","signer_title","accepted"],"description":"Signed by someone authorized to act for the business, once per business: that they are authorized, that the details match the business's IRS records, and that the business will text only people who agreed to it and will follow the Messaging Policy. Kept as signed, with the exact wording, who sent it (the API key), the IP address, the user agent and the date of our legal documents.","properties":{"signer_name":{"type":"string","minLength":2,"maxLength":120,"description":"The full name of the person signing."},"signer_title":{"type":"string","minLength":2,"maxLength":120,"description":"Their job title."},"accepted":{"type":"boolean","description":"Must be true: the person signing agrees to the statement."}}}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"sync_integration","title":"Sync integration","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"test_automation","title":"Test automation","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."},"properties":{"type":"object","additionalProperties":true,"description":"Sample event properties for merge fields"},"steps":{"type":"array","items":{"type":"string"},"description":"Only these send_sms step ids. Default: all of them"},"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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"test_webhook","title":"Test webhook","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"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"track_event","title":"Track event","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. external_id (their Mixpanel distinct_id, when not user_id) puts the texts it starts on their Mixpanel profile.","inputSchema":{"type":"object","required":["event"],"properties":{"event":{"type":"string","maxLength":64,"description":"Letters, digits, and _ . : -"},"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"},"external_id":{"type":"string","maxLength":255,"description":"Optional. The person's id in your analytics tool (their Mixpanel distinct_id; `mixpanel_distinct_id` is accepted too), when it is not user_id. Kept on the event as mixpanel_distinct_id; texts the event starts land on that profile in Mixpanel. Without it, user_id is used."},"phone":{"type":"string","description":"The person's number in E.164"},"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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"update_automation","title":"Update automation","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"},"name":{"type":"string","maxLength":80,"description":"Automation name"},"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."},"category":{"type":"string","nullable":true,"enum":["marketing","transactional","otp"],"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."},"trigger":{"type":"object","properties":{"event":{"type":"string","description":"The tracked event that starts a run"},"filters":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"property":{"type":"string","description":"The event property to check"},"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"}}},"description":"Up to 5 checks on the event's properties. All must hold"},"cooldown_seconds":{"type":"integer","minimum":60,"maximum":7776000,"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"},"steps":{"type":"array","maxItems":20,"items":{"type":"object","required":["type"],"description":"One of: send_sms {body, from?, send_time?, max_wait_seconds?}; wait {seconds}; wait_for_event {event, timeout_seconds, on_received, on_timeout}; condition {check, on_met, on_not_met}; end. Branches are \"continue\", \"end\", or \"goto:<id of a later step>\".","properties":{"id":{"type":"string","description":"Stable handle for goto branches; assigned when omitted."},"type":{"type":"string","enum":["send_sms","wait","wait_for_event","condition","end"],"description":"What the step does"},"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."},"send_time":{"type":"string","enum":["right_away","optimal_user_time"],"description":"send_sms: `optimal_user_time` waits for the hour this person usually replies or clicks, inside quiet hours. Default: right_away. Refused for one-time codes and order or shipping texts."},"max_wait_seconds":{"type":"integer","minimum":60,"maximum":86400,"description":"send_sms with optimal_user_time, required: the longest this text may wait for that hour"},"seconds":{"type":"integer","minimum":60,"maximum":2592000,"description":"wait: how long, from 60 seconds to 30 days"},"event":{"type":"string","description":"wait_for_event: the event to wait for"},"timeout_seconds":{"type":"integer","minimum":60,"maximum":2592000,"description":"wait_for_event: how long to wait, from 60 seconds to 30 days"},"on_received":{"type":"string","description":"wait_for_event: where to go when the event arrives: 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>"},"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."},"on_met":{"type":"string","description":"condition: where to go when the check passes: continue, end, or goto:<step id>"},"on_not_met":{"type":"string","description":"condition: where to go when the check fails: continue, end, or goto:<step id>"}}},"description":"Replaces every step."},"step":{"type":"object","required":["type"],"description":"One of: send_sms {body, from?, send_time?, max_wait_seconds?}; wait {seconds}; wait_for_event {event, timeout_seconds, on_received, on_timeout}; condition {check, on_met, on_not_met}; end. Branches are \"continue\", \"end\", or \"goto:<id of a later step>\".","properties":{"id":{"type":"string","description":"Stable handle for goto branches; assigned when omitted."},"type":{"type":"string","enum":["send_sms","wait","wait_for_event","condition","end"],"description":"What the step does"},"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."},"send_time":{"type":"string","enum":["right_away","optimal_user_time"],"description":"send_sms: `optimal_user_time` waits for the hour this person usually replies or clicks, inside quiet hours. Default: right_away. Refused for one-time codes and order or shipping texts."},"max_wait_seconds":{"type":"integer","minimum":60,"maximum":86400,"description":"send_sms with optimal_user_time, required: the longest this text may wait for that hour"},"seconds":{"type":"integer","minimum":60,"maximum":2592000,"description":"wait: how long, from 60 seconds to 30 days"},"event":{"type":"string","description":"wait_for_event: the event to wait for"},"timeout_seconds":{"type":"integer","minimum":60,"maximum":2592000,"description":"wait_for_event: how long to wait, from 60 seconds to 30 days"},"on_received":{"type":"string","description":"wait_for_event: where to go when the event arrives: 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>"},"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."},"on_met":{"type":"string","description":"condition: where to go when the check passes: continue, end, or goto:<step id>"},"on_not_met":{"type":"string","description":"condition: where to go when the check fails: continue, end, or goto:<step id>"}}},"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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"update_contact","title":"Update contact","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"},"phone_number":{"type":"string","description":"E.164, US or Canada"},"name":{"type":"string","maxLength":120,"nullable":true,"description":"Display name. Null clears it"},"tags":{"type":"array","maxItems":20,"items":{"type":"string","maxLength":40},"description":"Labels that group contacts"},"fields":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 string values"},"notes":{"type":"string","maxLength":2000,"nullable":true,"description":"Free-text notes. Null clears them"},"first_name":{"type":"string","maxLength":80,"nullable":true,"description":"First name. Null clears it"},"last_name":{"type":"string","maxLength":80,"nullable":true,"description":"Last name. Null clears it"},"email":{"type":"string","maxLength":254,"nullable":true,"description":"Email address. Null clears it"},"company":{"type":"string","maxLength":120,"nullable":true,"description":"Company name. Null clears it"},"state":{"type":"string","maxLength":40,"nullable":true,"description":"US state or Canadian province, usually a 2-letter code. Null clears it"},"source":{"type":"string","maxLength":60,"nullable":true,"description":"Where the contact came from. Null clears it"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"update_customer","title":"Update customer","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","maxLength":200,"nullable":true,"description":"The customer's name"},"external_id":{"type":"string","maxLength":200,"nullable":true,"description":"Your id for them; unique per account"},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Up to 50 string values"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"update_integration","title":"Update integration","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; exportEvents: false stops sending text events to Mixpanel (on by default); 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"},"status":{"type":"string","enum":["active","paused"],"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"},"phoneField":{"type":"string","description":"The tool's property holding the mobile number"},"phoneEvent":{"type":"string","description":"Mixpanel: an event that carries the number when profiles do not"},"phoneEventProperty":{"type":"string","description":"Mixpanel: that event's property holding the number (default phone)"},"exportEvents":{"type":"boolean","description":"Mixpanel (with a service account): send each text's events onto the person's Mixpanel profile: TextKit Message Sent, Delivered, Failed, Link Clicked, Reply Received and Opted Out, with the message, batch or automation and step ids and names. The person is matched by the batch recipient's external_id, the user id or mixpanel_distinct_id of the event that started the automation, or the contact Mixpanel supplied. On unless false. Needs a service account Mixpanel lets import (Admin or Owner on the project)."},"eventTriggers":{"type":"array","maxItems":20,"items":{"type":"object","properties":{"event":{"type":"string","description":"The TextKit event to record"},"mixpanel_events":{"type":"array","maxItems":10,"items":{"type":"string"},"description":"The Mixpanel events that map to it, up to 10"}}},"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."},"consentField":{"type":"string","description":"The tool's property that records SMS consent"},"consentEvent":{"type":"string","description":"Mixpanel / Amplitude: the opt-in event the cohort is built on"},"username":{"type":"string","description":"Mixpanel service account username"},"secret":{"type":"string","description":"Mixpanel service account secret"},"apiKey":{"type":"string","description":"Amplitude API key"},"secretKey":{"type":"string","description":"Amplitude secret key"},"accessToken":{"type":"string","description":"HubSpot private app token, or Shopify Admin API access token"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"update_list","title":"Update list","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","maxLength":200,"nullable":true,"description":"What the list is for"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"update_number_pool","title":"Update number pool","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"},"description":{"type":"string","description":"What the pool is for"},"routing":{"type":"string","enum":["sticky","local"],"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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"update_schedule","title":"Update schedule","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."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"update_segment","title":"Update segment","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"},"description":{"type":"string","maxLength":200,"nullable":true,"description":"What the segment is for"},"match":{"type":"string","enum":["all","any"],"default":"all","description":"all: a contact must match every rule. any: at least one rule"},"rules":{"type":"array","maxItems":10,"items":{"type":"object","required":["field"],"properties":{"field":{"type":"string","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"],"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)."},"key":{"type":"string","description":"The custom field name (field), topic id (topic), batch id (batch), or event name (event)"},"op":{"type":"string","enum":["is","is_not","contains","not_contains","exists","not_exists","before","after"],"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."},"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."}}},"description":"Up to 10 rules that decide who matches"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"update_template","title":"Update template","description":"Rename or edit a template.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Template id"},"name":{"type":"string","maxLength":60,"description":"Template name"},"body":{"type":"string","maxLength":1600,"description":"The message text, with merge tags"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"update_toll_free_verification","title":"Update toll free verification","description":"Change a toll-free verification: send only the fields to change. Allowed while draft, in_review (until it goes to the carriers) and rejected; after a rejection, fix what it asks for, then submit again.","inputSchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Toll-free verification id (tfv_...)"},"numbers":{"type":"array","items":{"type":"string"},"description":"Your live toll-free numbers this program texts from, E.164. One per business unless multiple_numbers_reason says why."},"multiple_numbers_reason":{"type":"string","description":"Why the program needs more than one number (one per store, say). Required with more than one number."},"business_name":{"type":"string","description":"The legal name, as on the IRS EIN letter, optionally with \"d/b/a\" and the brand your messages carry."},"ein":{"type":"string","description":"The EIN (US), matching the legal name; elsewhere the business registration number."},"entity_type":{"type":"string","description":"The kind of business.","enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"]},"street":{"type":"string","description":"Street address of the business."},"city":{"type":"string","description":"City."},"state":{"type":"string","description":"State or province code."},"postal_code":{"type":"string","description":"ZIP or postal code."},"country":{"type":"string","description":"Country of the business."},"contact_first_name":{"type":"string","description":"First name of the person the carriers can contact about this program."},"contact_last_name":{"type":"string","description":"Their last name."},"contact_phone":{"type":"string","description":"A phone number they answer."},"brand_email":{"type":"string","description":"The business's own email, for its customers: the HELP reply and the hosted opt-in page name it."},"website":{"type":"string","format":"uri","description":"The business's website."},"use_case":{"type":"string","description":"What the texts are for.","enum":["2fa","account_notification","customer_care","delivery_notification","fraud_alert","higher_education","marketing","mixed","polling_voting","public_service_announcement","security_alert","low_volume"]},"use_case_summary":{"type":"string","maxLength":1500,"description":"What the program sends, to whom and why. At least 40 characters."},"sample_messages":{"type":"array","maxItems":8,"items":{"type":"string","maxLength":640},"description":"At least two example messages."},"help_reply":{"type":"string","description":"The reply to HELP: names the business and how to reach it. Omit to keep ours."},"stop_reply":{"type":"string","description":"The reply to STOP: names the business and says they are unsubscribed. Omit to keep ours."},"opt_in_description":{"type":"string","maxLength":2000,"description":"How people opt in, step by step. At least 40 characters."},"opt_in_url":{"type":"string","format":"uri","description":"The opt-in page. With none of your own we make you a hosted one."},"opt_in_screenshot_url":{"type":"string","format":"uri","description":"A public image of the step where people enter their number and agree. Needed when the opt-in page itself has no phone field, like a later step of a form or an app."},"monthly_volume":{"type":"string","description":"How many texts a month this program sends."},"volume_basis":{"type":"string","enum":["existing","projecting"],"description":"existing: what it sends today. projecting: an estimate."},"advertising":{"type":"string","enum":["yes","no","unsure"],"description":"Whether the messages advertise a product or service."},"previous_service":{"type":"string","enum":["new","short_code","long_number"],"description":"Where this traffic ran before."},"previous_content":{"type":"string","maxLength":2000,"description":"Sample messages from the previous service (not new only)."},"previous_numbers":{"type":"string","description":"The numbers it used (not new only)."},"number_published":{"type":"string","description":"Where people see this number."},"fortune_500":{"type":"boolean","description":"The company is in the Fortune 500."},"urls_in_messages":{"type":"string","description":"Links your messages include, or \"None\"."},"phones_in_messages":{"type":"string","description":"Phone numbers your messages include, or \"None\"."},"terms_url":{"type":"string","format":"uri","description":"The terms page, with the SMS program terms."},"privacy_url":{"type":"string","format":"uri","description":"The privacy policy page."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"update_topic","title":"Update topic","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","maxLength":200,"nullable":true,"description":"What the topic covers"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"update_webhook","title":"Update webhook","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"},"events":{"oneOf":[{"type":"string","enum":["*"]},{"type":"array","items":{"type":"string"}}],"description":"Event types to send, or * for all"},"active":{"type":"boolean","description":"false pauses delivery; pending retries for a paused endpoint are dropped."},"description":{"type":"string","maxLength":120,"nullable":true,"description":"A note on what the endpoint is for"},"numbers":{"type":"array","maxItems":100,"nullable":true,"items":{"type":"string"},"description":"Replace the number filter; [] or null clears it."}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true}},{"name":"upsert_contact","title":"Upsert contact","description":"Create a contact, or update the existing one with the same phone_number.","inputSchema":{"type":"object","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"E.164, US or Canada"},"name":{"type":"string","maxLength":120,"description":"Display name. Defaults to first + last name."},"tags":{"type":"array","maxItems":20,"items":{"type":"string","maxLength":40},"description":"Labels that group contacts"},"fields":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 string values (account id, plan, location...), usable in segments and as {{field:key}} merge fields"},"notes":{"type":"string","maxLength":2000,"description":"Free-text notes"},"first_name":{"type":"string","maxLength":80,"description":"First name"},"last_name":{"type":"string","maxLength":80,"description":"Last name"},"email":{"type":"string","maxLength":254,"description":"Email address"},"company":{"type":"string","maxLength":120,"description":"Company name"},"state":{"type":"string","maxLength":40,"description":"US state or Canadian province, usually a 2-letter code"},"source":{"type":"string","maxLength":60,"description":"Where the contact came from. Defaults to \"api\"."},"opt_in":{"type":"object","description":"Import only (POST /v1/contacts/import). Stored as consent evidence; never lifts an opt-out.","properties":{"status":{"type":"boolean","description":"true = opted in; false = unsubscribed (recorded as an opt-out)"},"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"},"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"},"page_url":{"type":"string","format":"uri","description":"The page a web-form opt-in was collected on"}}}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"verify_link_domain","title":"Verify link domain","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_...)"}}},"annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":false}},{"name":"wait_for_events","title":"Wait for events","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","minimum":0,"maximum":25,"default":20,"description":"Seconds to hold the request."}}},"annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}}],"prompts":[{"name":"import_audience","description":"Bring people from anywhere (analytics, CRM, store, email tool, billing, database, spreadsheet, file) into TextKit as tagged contacts and a segment. It asks where they are first if you have not said, then offers every way in. Run it again to refresh."},{"name":"build_automation","description":"Set up texts that go out when something happens (a signup, a paywall view, a failed payment): it asks which event starts it, how long after, whether to use optimal user time, what ends it, follow-ups, who gets it and the message, then builds a draft, previews it and sends you a test."},{"name":"send_campaign","description":"Text an audience: find or import it, draft the message, dry-run it, and send or schedule only after you approve."},{"name":"campaign_report","description":"How your texts did: delivery, replies, opt-outs and spend per batch, the trend, and who to follow up with."},{"name":"help","title":"TextKit commands","description":"Every TextKit command and what it does. Or describe a task and it picks the right one."},{"name":"balance","title":"Balance and usage","description":"Credit balance, this month's usage and the spend limit. Change the spend limit."},{"name":"numbers","title":"Phone numbers","description":"Your numbers and what each is approved for. Search, buy, release, pool or move numbers."},{"name":"send","title":"Send a text","description":"Send one text, see recent texts, look up a number, or delete and redact a text."},{"name":"batch","title":"Broadcasts","description":"Text a segment, tag or list: dry run first, then send or schedule. Pause, resume, cancel or retry a batch."},{"name":"schedule","title":"Scheduled and recurring texts","description":"Texts waiting to go out and recurring schedules. Create, change or cancel them."},{"name":"verify","title":"Verification codes","description":"Send and check one-time codes, fall back to a call or another channel, look up a verification."},{"name":"register","title":"10DLC and toll-free registration","description":"Register for 10DLC or verify a toll-free number: filled from your website, checked, then filed when you approve."},{"name":"contacts","title":"Contacts and lists","description":"Find, add, import, tag, update or delete contacts, and manage fixed lists."},{"name":"audience","title":"Segments","description":"Ask who did what (replied, clicked, got a batch) and save it as a segment to text."},{"name":"consent","title":"Consent, opt-outs and topics","description":"Who agreed to texts and who opted out. Record consent, import a STOP list, manage topics."},{"name":"templates","title":"Message templates","description":"Saved texts with merge fields. Create, change or delete them."},{"name":"automations","title":"Automations","description":"Texts that go out when something happens. Build, preview, test, turn on or pause them, and see runs."},{"name":"links","title":"Tracked links","description":"Short links with clicks and conversions, and your own link domain."},{"name":"integrations","title":"Integrations","description":"Connect Mixpanel, Amplitude, HubSpot, Shopify or Salesforce, sync it, see its events, or disconnect."},{"name":"webhooks","title":"Webhooks and events","description":"Webhook endpoints, deliveries and the event log. Add, test, replay or rotate a secret."},{"name":"customers","title":"Customers","description":"Accounts you text on behalf of (for platforms): create, change, delete and see their usage."},{"name":"api_keys","title":"API keys","description":"Your API keys. Create one for an app, or revoke one."},{"name":"reports","title":"Delivery and reports","description":"Delivery rates and failure reasons, raw exports and the audit log."}]}