Jointextkit

TextKit

Programmable SMS and phone numbers for developers. Send and receive texts, verify phone numbers, and provision numbers with one REST API. Test keys…

Communication#phone

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Programmable SMS and phone numbers for developers. Send and receive texts, verify phone numbers, and provision numbers with one REST API. Test keys (tk_sk_test_...) work instantly against the sandbox; live keys are enabled after a short live-access review.

Endpoints 162

  • GETList messages/messages
  • POSTSend an SMS/messagesSends an SMS from one of your numbers. In test mode the message is simulated: it reaches delivered but no text is sent (simulated: true, an…
  • GETRetrieve a message/messages/:id
  • DELETEDelete a message/messages/:idDeletes a finished message (delivered, failed, received, or sent with receipt_status: "missing") and every copy of its text: the events about it, pending…
  • POSTRedact a message/messages/:id/redactEmpties a finished message's body and media everywhere we keep them (the message, its events, pending webhook retries, request logs, the conversation preview,…
  • GETList batches/batches
  • POSTSend a batch/batchesOne body to up to 10,000 recipients, each with its own merge variables (or to contacts by tag), sent as individual messages through the normal pipeline.…
  • GETRetrieve a batch/batches/:id
  • GETList a batch’s recipients/batches/:id/recipients
  • GETResults of a batch/batches/:id/resultsWhat happened after the queue: attempted = delivered + failed + pending. delivered and failed come from carrier delivery receipts; pending was accepted by the…
  • POSTPause a batch/batches/:id/pauseHolds every message not yet handed to the carrier. Messages already in flight still send.
  • POSTResume a paused batch/batches/:id/resumeRe-queues held messages, paced from now (or from scheduled_at if still in the future).
  • POSTCancel a batch/batches/:id/cancelCancels a scheduled batch, or stops a sending/paused one: every unsent message is canceled and counted. If sweep_complete is false (very large batches), call…
  • POSTRetry failed recipients/batches/:id/retryRe-queues failures that can succeed on a retry (rate limits, quota, carrier errors, a content check outage, and credits, spend limit, billing, registration or…
  • GETList scheduled messages/scheduled_messagesPending 1:1 messages created with POST /messages scheduled_at. Batches list their own recipients.
  • GETRetrieve a pending scheduled message/scheduled_messages/:id404 once it has sent (it is a message then: GET /messages) or was canceled.
  • DELETECancel a scheduled message/scheduled_messages/:id
  • POSTSend a verification code/verifyGenerates a one-time code and sends it by text (channel: "sms", the default) or by email (channel: "email" with email). Enforces expiry, attempt limits and…
  • POSTEmail the code instead/verify/:id/fallbackThe text did not arrive: email a code for the same verification. One verification id, so one charge when the code is checked. The email carries a new code…
  • POSTCheck a verification code/verify/checkThe only billable moment in Verify. charged tells you whether this call was billed.
  • GETRetrieve a verification/verify/:id
  • GETSearch available numbers/numbers/available
  • GETList your numbers/numbers
  • POSTPurchase a number/numbersSupports the Idempotency-Key header: a retried purchase replays the original 201.
  • POSTAttach a number to a registration/numbers/:id/registrationTies a live US local number to one of your registrations. Needed only when you have more than one approved registration, or to retry a link that failed;…
  • GETRetrieve a number/numbers/:idOne of your active numbers, with sender: how it stands with the carriers, and throughput: the pace TextKit holds it to.
  • DELETERelease a number/numbers/:id
  • PATCHAssign a number to a customer/numbers/:id
  • GETList contacts/contacts
  • POSTCreate or update a contact/contactsOne contact per phone number. Creates the contact (201) or updates the one that already has this number (200). Values you leave out are kept and tags are…
  • GETQuestions to settle before a task/planFor anything a person does here (send a text, buy or release a number, register for 10DLC, verify a toll-free number, request a short code, send verification…
  • GETQuestions to settle before a send/campaigns/planEvery input an automation or a broadcast needs, as questions to ask the person, each with this account's options: for an automation, the starting event…
  • GETWays to bring an audience in/contacts/import/sourcesWhere an audience can come from and every way to bring it here. Without source: the questions to ask (where the people are, which group, what you can sign in…
  • POSTBulk create or update contacts/contacts/importUp to 500 per request, keyed on phone number, with the same merge rule as POST /contacts. Rows that cannot be imported come back in skipped; the rest still…
  • POSTTag, untag, or delete many contacts/contacts/bulkOne action for up to 500 contact ids. Ids that do not exist are counted in missing; the rest are applied.
  • GETRetrieve a contact/contacts/:idIncludes consent_status, each topic's subscription, and the saved segments the contact is in right now. id may also be the contact's phone number.
  • DELETEDelete a contact/contacts/:idMessages, consent records and topic preferences for the number are untouched.
  • PATCHUpdate a contact/contacts/:idOnly the fields sent change. tags and fields replace what is stored; null clears name or notes, and null or an empty string clears any other optional property.
  • GETList customers/customers
  • POSTCreate a customer/customersA business you send on behalf of. Assign numbers to it and its messages, verifications, events and usage carry its id. Optional; nothing requires customers.
  • GETRetrieve a customer/customers/:id
  • DELETEDelete a customer/customers/:idUnassigns its numbers (they stay on your account). Messages, events and usage already attributed keep the id.
  • PATCHUpdate a customer/customers/:idOnly the fields sent change. metadata replaces the whole object; null clears a field.
  • GETA customer's usage/customers/:id/usageUTC days, inclusive, up to 366. Follows the key: test keys report sandbox traffic, live keys live traffic.
  • POSTAct on many numbers at once/numbers/bulkTag, untag, label, pool, unpool or release up to 1000 numbers (100 for release). Returns 200 with a result per id even when some fail. Release requires…
  • POSTBuy many numbers in an area code/numbers/bulk-purchaseQuota is checked for the whole quantity up front (429, nothing bought). After that, carrier refusals are reported per number and backfilled from spare…
  • GETList open short-code and toll-free requests/numbers/requestsRequests you filed (here or in the console) that our team has not closed yet. Scope: numbers:read.
  • POSTRequest a short code (or a toll-free number set up by our team)/numbers/requestsFiles a request with our team; it provisions nothing by itself. We set the number up with you by email. Carriers take 8 to 12 weeks to approve a short code,…
  • GETExport numbers as CSV/numbers/export
  • GETList sender pools/numbers/pools
  • POSTCreate a sender pool/numbers/pools
  • GETRetrieve a pool/numbers/pools/:id
  • DELETEDelete a pool/numbers/pools/:idIts numbers stay on your account; sends that name this pool start failing.
  • PATCHRename a pool/numbers/pools/:id
  • POSTClone a pool/numbers/pools/:id/cloneNew pool with the same description and members. Numbers can belong to several pools.
  • GETLook up a phone number/lookup/:phoneCarrier, line type, and caller name for any US/Canada number.
  • GETA contact's topic subscriptions/contacts/:id/topicsid is a contact id or a phone number (preferences belong to the number, so a number that is not a contact still answers). consent_status is the global opt-out…
  • PUTSubscribe or unsubscribe a contact from a topic/contacts/:id/topics/:topictopic is a topic id or name. Recorded in the consent ledger and the audit log. No record means subscribed, so only an unsubscribe narrows who is sent to.…
  • GETList lists/lists
  • POSTCreate a list/listsA list is a fixed group of contacts you add and remove on purpose (a segment is the rule-based kind). Add people with POST /lists/{id}/contacts, with list_id…
  • GETRetrieve a list/lists/:id
  • DELETEDelete a list/lists/:idDeletes the list, not the contacts.
  • PATCHUpdate a list/lists/:id
  • GETList a list's contacts/lists/:id/contactsMost recently added first.
  • POSTAdd contacts to a list/lists/:id/contactsUp to 1,000 per request between contact_ids and phone_numbers. Numbers must already be contacts; any that are not come back in not_found.
  • DELETERemove contacts from a list/lists/:id/contactsSame body as adding. The contacts stay contacts.
  • GETList segments/segments
  • POSTCreate a segment/segmentsA segment is a saved, named filter over contacts (an audience, unrelated to the segments count on a message). It is evaluated when used, so it always reflects…
  • GETRetrieve a segment/segments/:id
  • DELETEDelete a segment/segments/:idDeletes the filter, not the contacts.
  • PATCHUpdate a segment/segments/:idSend name / description alone, or rules (and match) to replace the whole rule list.
  • POSTQuery an audience without saving it/segments/previewRuns a rule list now and answers with the counts GET /segments/{id}/preview gives plus the first limit matching contacts. Use it to ask cohort questions (who…
  • GETCount a segment/segments/:id/previewHow many contacts the segment matches now and how many would receive a broadcast: opted-out contacts are removed, then (with topic_id) those unsubscribed from…
  • GETList API keys/api_keysActive keys of the calling key's mode (a test key lists test keys). Never the secrets.
  • POSTCreate an API key/api_keysA key for an app you build, to keep as a secret (for example TEXTKIT_API_KEY). Same mode as the calling key. A key with limited scopes can only create keys…
  • DELETERevoke an API key/api_keys/:idImmediate and permanent. Only keys of the calling key's mode.
  • GETList subscription topics/topicsEvery account starts with Marketing (tp_marketing), Account alerts (tp_account_alerts) and Product updates (tp_product_updates). Up to 20 topics.
  • POSTCreate a topic/topics
  • GETRetrieve a topic/topics/:id
  • DELETEDelete a topic/topics/:idRecipients' recorded preferences for the topic are kept as consent history, and batches already created with it keep honoring them.
  • PATCHRename or describe a topic/topics/:id
  • GETList opted-out numbers (suppression list)/consent
  • GETConsent state and append-only history for one number/consent/:phone
  • POSTSet consent state from your own system (CRM sync)/consent/:phoneOpting in a number that opted out needs proof with collected_at at or after the opt-out (a STOP cancels earlier consent); otherwise 409 invalid_request with…
  • POSTBulk-import a suppression list (up to 500 numbers)/consent/import
  • GETExport the suppression list, or the full consent ledger with opt-in proof, as CSV/consent/export
  • GETList brand + campaign registrations/registrations
  • POSTCreate a registration and run the website disclosure check/registrationsFetches the website, privacy policy, terms (discovered from homepage links when not given) and opt-in page, and checks them against carrier requirements. Also…
  • POSTSuggest a registration from a website/registrations/prefillReads the public pages of the website (homepage plus the sign-up, contact, privacy and terms pages it links to) and returns suggestions for a registration:…
  • GETGet a registration/registrations/:id
  • POSTRe-run the checks (optionally correcting input fields)/registrations/:id/recheckAllowed in draft, checks_failed, ready and rejected. Any RegistrationInput field may be sent to correct it, including sample_messages and description;…
  • POSTEnter a sole proprietor's phone code/registrations/:id/phone-checkAfter submitting, a sole proprietor gets a code at the mobile in brand.contact_phone (phone_check on the registration shows it is waiting). It lasts 24 hours.…
  • POSTSend a sole proprietor a new phone code/registrations/:id/phone-check/resendThe old code stops working. At most 5 codes per submission, one a minute.
  • POSTSubmit a ready registration for carrier review (or resubmit after a rejection)/registrations/:id/submitThe body must carry fees_acknowledged: true: your acceptance of the registration fee terms (Terms §4.3). Carrier registration fees (brand, vetting, the…
  • GETList the filed copies of a registration/registrations/:id/submissionsOne entry per submission, oldest first: exactly what was sent for carrier review (business details, example messages, description, opt-in story) and how the…
  • GETList toll-free verifications/toll-free-verificationsYour toll-free verifications, newest first. Each lists its numbers, status, the form, what would get it sent back (problems) and the carriers' answer.
  • POSTStart a toll-free verification/toll-free-verificationsStarts the carriers' toll-free verification form for one or more of your live toll-free numbers, filled in from what we already have: your registration,…
  • GETGet a toll-free verification/toll-free-verifications/:idIts status, the form, what would get it sent back (problems), its business, and the carriers' answer (rejection.reason) when it was sent back.
  • PATCHChange a toll-free verification's answers/toll-free-verifications/:idSend 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 here,…
  • POSTSubmit a toll-free verification for review/toll-free-verifications/:id/submitSends a draft, or a rejected form you fixed, for review: it comes back in_review. We check every form, usually within minutes, then send it to the carriers…
  • GETList events/events
  • GETLong-poll for new events/events/waitHolds the request until an event newer than cursor exists or timeout seconds pass, then returns the new events oldest first and the cursor to send next. Call…
  • POSTReplay an event to one webhook endpoint/events/:id/replaySends the stored event to the endpoint you name, now, and returns its answer. Not retried. Works for paused endpoints and ones not subscribed to the event type.
  • GETList integrations/integrationsThe tools connected to this account (Shopify, HubSpot, Salesforce, Mixpanel, Amplitude, webhook): status, settings, last sync, list. Credentials are never…
  • POSTConnect a tool/integrationsConnects a tool with its API key or service account, the same as the console's Integrations page: the credentials are proved with one read, then sealed and…
  • GETGet an integration/integrations/:idOne integration, without credentials. Scope: contacts.
  • DELETEDisconnect an integration/integrations/:idDeletes its credentials and its list. The contacts stay, with their consent records. Scope: contacts.
  • PATCHUpdate an integration/integrations/:idRename it, pause or resume it (status), or change its settings or credentials (credentials left out keep the stored ones). Scope: contacts.
  • GETEvent catalog of an integration/integrations/:id/eventsMixpanel: every TextKit event its eventTriggers map, with the Mixpanel events that feed it and how often each fired in the project over the last 7 days, how…
  • POSTSync an integration now/integrations/:id/syncReads the source now (pull integrations), up to 6 times an hour. Answers found, added, updated, left the list, opted out. Scope: contacts.
  • GETList webhook endpoints/webhooksYour endpoints. Signing secrets are never listed: one is returned once, by the POST that creates the endpoint. Scope: webhooks.
  • POSTCreate a webhook endpoint/webhooksRegisters a URL to receive events. Same rules as the console: https only, a publicly reachable host, known event types, at most 5 endpoints per account. The…
  • GETGet a webhook endpoint/webhooks/:idOne endpoint, without its signing secret. Scope: webhooks:write.
  • DELETEDelete a webhook endpoint/webhooks/:idRemoves the endpoint and stops delivery to it. Recorded in the audit log as webhook.deleted. Scope: webhooks:write.
  • PATCHUpdate a webhook endpoint/webhooks/:idChange the URL, the subscribed events, or pause and resume delivery with active. Send only the fields to change. The signing secret is unchanged (POST…
  • POSTCreate or rotate the status callback secret/webhooks/callback_secretThe signing secret for status_callback requests (POST /v1/messages), returned once. The first call creates it (201); a later call replaces it (200) and the…
  • POSTRotate a webhook signing secret/webhooks/:id/rotate_secretReplaces the signing secret and returns the new one: the only time the API shows it. With expire_previous_in, the old secret keeps signing for that many…
  • POSTSend a test event to a webhook endpoint/webhooks/:id/testSends a signed test.ping event now and returns what the endpoint answered. Test pings are not stored as events (they cannot be replayed) but the attempt shows…
  • POSTReplay every failed delivery to an endpoint/webhooks/:id/replayQueues each event whose deliveries to this endpoint all failed between since and until (default: the last 24 hours; at most 7 days and 50 events a call).…
  • GETList webhook delivery attempts/webhooks/deliveriesEvery attempt to push an event to your endpoints, newest first, kept 30 days: status code, latency, attempt number and the first 2 KB of the response body.
  • GETDelivery rates by day, carrier, number, country, category, customer, or error code/deliverabilityFinal outcomes (delivered/failed) aggregated over a UTC date range of up to 90 days. Test keys report sandbox traffic, live keys live traffic. country is the…
  • GETGet the prepaid credit balance and auto-recharge setting/balanceBillable live calls draw the balance down; a call it cannot cover answers 402 insufficient_credits and is not charged. Amounts ending in _micro_usd are…
  • GETGet the monthly spend limit and this month's estimated spend/spend-limitScope: billing.
  • PATCHSet or remove the monthly spend limit and alert thresholds/spend-limitLive outbound messages that would exceed the cap are rejected with 403 spend_limit_reached and not charged. Thresholds fire spend.threshold_reached once each…
  • GETGet account usage by month, today's counters, and plan limits/usageCounts for the whole account, so test and live keys read the same numbers. Months and days are UTC; the current month comes first and is month-to-date. Scope:…
  • GETList audit log entries/audit-logsAccount changes (keys, team, webhooks, spend limit, numbers, consent, settings) with actor and IP, newest first. Filters apply before paging. One request…
  • GETExport messages, delivery results, events, opt-outs, webhook deliveries, usage, credit history or the audit log as CSV/exports/:kindStreams a CSV (UTF-8 with BOM). At most 50,000 rows per export (header X-Export-Row-Cap); narrow the date range if you hit it. Cells that would be spreadsheet…
  • POSTTrack a customer event/trackRecords something a person did in your app and starts or advances the automations listening for it. Pass phone, user_id, or both; a call with both links them…
  • GETList recurring schedules (at most 100 per account)/schedulesScope: messages:read.
  • POSTCreate a recurring schedule/schedulesSends one message to one number on a repeating wall-clock time in an IANA time zone, correct across daylight saving. Each occurrence goes through the same…
  • GETRetrieve a schedule, with its recent occurrences/schedules/:idScope: messages:read.
  • DELETEDelete a schedule/schedules/:idStops it for good and deletes its occurrence records. Messages it already sent stay in the message log. Scope: messages:send.
  • PATCHChange, pause or resume a schedule/schedules/:idactive: false pauses; active: true resumes from now (nothing that came due while paused is sent). Any of to, from, body, repeat (the whole object),…
  • GETList automations (at most 50 per account)/automationsScope: automations.
  • POSTCreate an automation (as a draft)/automationsThe response lists issues: everything that stops the flow from being activated. Scope: automations.
  • GETRetrieve an automation/automations/:id
  • DELETEDelete an automation/automations/:idRuns in progress end with end_reason flow_deleted the next time they wake; nothing more is sent.
  • PATCHEdit an automation/automations/:idEditing an active automation publishes a new version at once and must leave it valid; runs in progress finish on the version they started with. Pause first to…
  • POSTActivate an automation/automations/:id/activateAnswers 400 with issues when the flow is not ready. At most 20 automations can be active at once.
  • POSTPause an automation/automations/:id/pauseStops new runs and holds runs in progress where they are until it is activated again.
  • GETPreview an automation/automations/:id/previewEvery send_sms step as it would go out, without sending anything. Works on drafts. Merge fields are filled from the sample event properties and, with to, that…
  • POSTSend an automation as a test/automations/:id/testSends the automation's texts to to now, one after another, skipping waits and conditions. Works on drafts and active automations and does not activate them;…
  • DELETEForget the phone number linked to a user_id/automations/identities/:user_idRemoves the user_id to phone link that a tracked event carrying both taught us (see POST /v1/track). Later events with only that user_id start nothing until a…
  • GETList an automation's runs, newest first/automations/:id/runsRuns are kept for 30 days after they end.
  • GETRetrieve a run with its timeline/automations/:id/runs/:run_id
  • DELETECancel a run in progress/automations/:id/runs/:run_idThe run stays readable, ended with end_reason canceled. 409 if it is advancing at this moment.
  • GETRecommend which text to send/copy/recommend?industry=apparel&company_type=ecommerce&brand=string&product=stringCandidate SMS copy for a goal, ranked by expected revenue per message, each with the evidence behind its score: the factors that moved it and how many case…
  • GETList message templates (at most 100 per account)/templates
  • POSTCreate a template with {{merge}} fields/templates
  • GETRetrieve a template/templates/:id
  • DELETEDelete a template/templates/:id
  • PATCHRename or edit a template/templates/:id
  • GETList tracked links/linksEvery tracked destination: links you made and links sent in texts, with texts, clicks, conversions and value. Scope: links.
  • POSTCreate a tracked link/linksA short link to copy anywhere, on your own link domain when one is active, else ours. The same url again returns the same link with 200. Scope: links.
  • GETList conversions/conversionsThe latest 100, newest first. Scope: links.
  • POSTReport a conversion/conversionsA sale or sign-up from someone who came through a tracked link. Scope: links.
  • GETList link domains/link-domainsYour short-link domains (at most 3) and where each stands. Scope: links.
  • POSTAdd a link domain/link-domainsAdd a subdomain of your own (links.example.com) to carry short links (shorten_links on POST /messages). Optional: without one, tracked links go on our domain.…
  • GETRetrieve a link domain/link-domains/:id
  • DELETEDelete a link domain/link-domains/:idIts short links stop opening at once (404); sent messages keep their text and click counts. Recorded in the audit log as link_domain.deleted. Scope: links.
  • POSTCheck a link domain DNS records/link-domains/:id/verifyLooks up the CNAME and TXT records now. Both found: the domain is turned on (active); the certificate can take a minute or two. Always 200 with the domain;…
  • POSTSimulate an inbound SMS (test keys only)/test/inboundRuns through the real inbound pipeline and emits message.received with simulated: true. Once the account has live access, STOP, START, YES and HELP change…

API details

Base URL
https://api.jointextkit.com/v1
Authentication
A bearer token in the Authorization header
Operations
162 operations on 108 pathsGET 71POST 57DELETE 19PATCH 14PUT 1
Response formats
application/json text/csv
Description format
OpenAPI 3.0.3, API version 1.0.0

How to test the TextKit in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the TextKit collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List messages” (GET /messages), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the TextKit?

Programmable SMS and phone numbers for developers. Send and receive texts, verify phone numbers, and provision numbers with one REST API. Test keys… It is listed under Communication and has 162 endpoints.

Who publishes the TextKit?

It is listed from Jointextkit's public API description (an OpenAPI document), not published by Jointextkit on Swastik Codes. Anyone who controls jointextkit.com can claim the profile by adding a DNS TXT record.

What is the base URL of the TextKit?

Requests go to https://api.jointextkit.com/v1. Endpoint paths are added to this base URL.

How do I authenticate with the TextKit?

With A bearer token in the Authorization header.

How many endpoints does the TextKit have?

162 operations on 108 paths (71 GET, 57 POST, 19 DELETE, 14 PATCH, 1 PUT).

Is forking the TextKit free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.