activate_automation
ChatGPTTurn an automation on, so tracked events start runs. With a live number it texts real people.
add_to_list
ChatGPTAdd contacts to a list by contact_ids and/or phone_numbers (up to 1,000; numbers must already be contacts).
assign_number_to_customer
ChatGPTPlatforms: attribute a number (and its messages and usage) to one of your customers, or clear it with customer_id null.
bulk_purchase_numbers
ChatGPTBuy several numbers in one area code at once (e.g. for a sender pool). Live numbers are billed monthly each.
cancel_automation_run
ChatGPTCancel a run in progress.
cancel_batch
ChatGPTCancel a batch. Messages already sent stay sent.
cancel_scheduled_message
ChatGPTCancel a scheduled message before it sends.
create_automation
ChatGPTCreate 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. Drafts send nothing until activated.
create_customer
ChatGPTPlatforms sending for other businesses: create a customer to attribute numbers, messages and usage to.
create_list
ChatGPTCreate a list: a fixed group of contacts (Audience → Lists). Use a list when the user names exactly who belongs ("add these people to VIPs"); use a segment when membership follows rules.
create_schedule
ChatGPTSend 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.
create_segment
ChatGPTSave 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.
create_template
ChatGPTSave a message template. Merge tags: {{first_name}}, {{name}}, {{phone}}, {{field:<custom>}}, and per-recipient variables.
create_topic
ChatGPTCreate a subscription topic, so people can opt out of one kind of message (e.g. promotions) and keep others.
create_webhook
ChatGPTSend events (message.received, message.delivered, message.opted_out, ...) to a URL: your app, a CRM, an automation tool. Returns the signing secret once.
delete_automation
ChatGPTDelete an automation.
delete_contact
ChatGPTDelete a contact. Messages, consent records, and topic preferences for the number are kept.
delete_customer
ChatGPTDelete a customer.
delete_list
ChatGPTDelete a list (its contacts stay).
delete_message
ChatGPTDelete 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.
delete_schedule
ChatGPTDelete a recurring schedule.
delete_segment
ChatGPTDelete a segment. Contacts are not touched.
delete_template
ChatGPTDelete a template.
delete_topic
ChatGPTDelete a topic you created (built-in topics stay).
delete_webhook
ChatGPTDelete a webhook endpoint.
disconnect_integration
ChatGPTDisconnect a tool: its credentials and its list are deleted; the contacts stay with their consent.
get_automation
ChatGPTRetrieve an automation with its trigger and steps.
get_automation_run
ChatGPTRetrieve one run with its step-by-step timeline.
get_balance
ChatGPTPrepaid credit balance and auto-recharge setting.
get_batch
ChatGPTRetrieve a batch with its progress counts.
get_batch_results
ChatGPTResults of a batch: delivered, failed, pending, replies, opt-outs (stops), spend, and failures grouped by reason.
get_consent
ChatGPTWhether a number is opted in or out, per registration, with its full consent history and proof.
get_contact
ChatGPTRetrieve a contact.
get_contact_topics
ChatGPTA contact's subscription to each topic.
get_customer
ChatGPTRetrieve a customer.
get_customer_usage
ChatGPTA customer's messages, verifications and spend for a period.
get_deliverability
ChatGPTDelivery rates by day, destination carrier, or sending number.
get_integration
ChatGPTOne connected tool and its last sync.
get_list
ChatGPTRetrieve a list and its contact count.
get_message
ChatGPTRetrieve a message by its msg_... id, with its delivery timeline.
get_number
ChatGPTRetrieve one of your numbers: status, sender registration, tags, pools, customer.
get_registration
ChatGPTA registration with its checks, status, and linked numbers.
get_schedule
ChatGPTRetrieve a recurring schedule with its recent occurrences.
get_scheduled_message
ChatGPTRetrieve a pending scheduled message.
get_segment
ChatGPTRetrieve a segment and its rules.
get_spend_limit
ChatGPTThe monthly spend limit and this month's estimated spend.
get_template
ChatGPTRetrieve a template.
get_toll_free_verification
ChatGPTA toll-free verification: status, numbers, the form, what is missing (problems), and the carriers' reason when it was rejected.
get_topic
ChatGPTRetrieve a topic.
get_usage
ChatGPTUsage by month, today's counters, and plan limits.
get_webhook
ChatGPTRetrieve a webhook endpoint.
import_contacts
ChatGPTCreate 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.
import_opt_outs
ChatGPTBring 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.
link_number_to_registration
ChatGPTAttach a number to an approved 10DLC registration so it can send that registration's traffic.
list_automation_runs
ChatGPTList an automation's runs, newest first.
list_automations
ChatGPTList automations.
list_batch_recipients
ChatGPTList a batch's recipients with each one's status.
list_batches
ChatGPTList batches (broadcasts), newest first.
list_contacts
ChatGPTList contacts, newest first. Filter by tag, segment_id, list_id, exact phone_number, or a free-text q (name, email, company).
list_customers
ChatGPTList your customers.
list_events
ChatGPTList recent events (message.sent/delivered/failed/received, number.purchased/released, ...), newest first.
list_integrations
ChatGPTThe connected tools: status, settings, last sync (found, added, opted out), and their list. No credentials.
list_list_contacts
ChatGPTPage through a list's contacts, most recently added first.
list_lists
ChatGPTList contact lists with their contact counts.
list_messages
ChatGPTList your messages, newest first. Filter by number, direction, status, failure reason, date, batch schedule or customer.
list_number_requests
ChatGPTOpen short-code and toll-free requests.
list_numbers
ChatGPTList the phone numbers on your account.
list_opt_outs
ChatGPTList opted-out numbers (the suppression list).
list_registrations
ChatGPTList 10DLC brand and campaign registrations and their status. Marketing from a local number needs an approved one.
list_scheduled_messages
ChatGPTList single messages scheduled for later and not yet sent.
list_schedules
ChatGPTList recurring schedules.
list_segments
ChatGPTList saved segments.
list_templates
ChatGPTList message templates.
list_toll_free_verifications
ChatGPTList toll-free verifications and their status (draft, in_review with our team, submitted to the carriers, verified, rejected). A toll-free number texts the public only once verified.
list_topics
ChatGPTList subscription topics.
list_webhook_deliveries
ChatGPTDelivery attempts to your webhook endpoints, with response status codes.
list_webhooks
ChatGPTList webhook endpoints.
lookup_phone
ChatGPTLook up line type (mobile, landline, VoIP) and carrier for any US/Canada number.
pause_automation
ChatGPTPause an automation: no new runs start, and runs in progress wait where they are until it is activated again.
pause_batch
ChatGPTPause a sending or scheduled batch.
preview_segment
ChatGPTCount 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).
purchase_number
ChatGPTBuy a phone number for your account (free sandbox numbers with test keys). Live numbers are billed monthly.
redact_message
ChatGPTEmpty a finished message's text and media everywhere it is kept, keeping its status, price and timeline (redacted_at is set). Cannot be undone.
release_number
ChatGPTRelease a number you own. It cannot be got back.
remove_from_list
ChatGPTRemove contacts from a list (they stay contacts).
replay_event
ChatGPTSend an event again to one webhook endpoint (after fixing the receiver).
replay_failed_webhooks
ChatGPTRe-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.
request_short_code
ChatGPTAsk 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.
resume_batch
ChatGPTResume a paused batch.
retry_batch
ChatGPTRetry a batch's failed recipients.
rotate_webhook_secret
ChatGPTReplace 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.
search_available_numbers
ChatGPTSearch purchasable numbers by area code (default 415).
send_batch
ChatGPTSend one message to many people (a broadcast or campaign): pick recipients by segment_id, tags, contact_ids, or an explicit recipients list. Opted-out numbers, numbers without marketing consent, and people unsubscribed from topic_id are removed before sending. dry_run: true sends nothing and returns the count, cost, rejected rows and consent.no_opt_in (recipients the send will skip for having no opt-in). scheduled_at sends later (up to 30 days). With a live key it texts real people.
send_message
ChatGPTSend one SMS from one of your numbers. Set category "marketing" for promotions (the opt-in check applies) and scheduled_at to send later. Quiet hours apply to every message: outside 8am-9pm (8pm in Florida, Maryland and Oklahoma) in the recipient's local time a marketing message is refused and anything else is held until 8am, except one-time codes and replies within 4 hours of their text. In sandbox (test keys), delivery is simulated: +15005550006 delivers, +15005550002 fails, +15005550007 is filtered as spam, +15005550013 delivers after a delay, +15005550016 has no opt-in (see /docs/sandbox).
set_consent
ChatGPTRecord 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).
set_contact_topic
ChatGPTSubscribe a contact to a topic, or unsubscribe them (e.g. "promotions" vs "order updates").
simulate_inbound
ChatGPTSandbox only: simulate an inbound SMS to one of your test numbers (emits message.received; STOP, START and HELP act as for real).
sync_integration
ChatGPTSync a connected tool now (up to 6 times an hour) and get what changed.
test_webhook
ChatGPTSend a signed test.ping to a webhook endpoint and see what it answered.
track_event
ChatGPTRecord 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.
update_automation
ChatGPTEdit an automation (name, sender, trigger, or steps).
update_contact
ChatGPTUpdate a contact. Only the inputs you pass change; tags and fields replace the whole list or map.
update_customer
ChatGPTRename a customer or change its external_id or metadata.
update_list
ChatGPTRename a list or change its description.
update_schedule
ChatGPTPause (active: false) or resume (active: true) a recurring schedule.
update_segment
ChatGPTRename a segment or replace its rules.
update_template
ChatGPTRename or edit a template.
update_topic
ChatGPTRename or describe a topic.
update_webhook
ChatGPTChange a webhook endpoint: URL, events, or turn it off (active: false).
upsert_contact
ChatGPTCreate a contact, or update the existing one with the same phone_number.