canonical: https://jentic.com/apis/messagingchannel.com/text2vip

# Messagingchannel Text2VIP API

Text2VIP is an SMS marketing platform that drives customer engagement by managing keyword-based subscriptions, campaign sends, and distribution lists. The REST surface lets agents create, list, retrieve, update, delete, and search subscriptions for a given account, with all operations scoped under a `{user_name}` path segment so multi-account orchestration is straightforward. It is suited to retailers, restaurants, and service businesses running SMS-loyalty programs that capture opt-ins via a keyword or short code.

## For AI agents

Manage SMS marketing subscriptions on Text2VIP - create, update, list, search, and remove subscribers under a user account.

## Scope

Does not handle email marketing, voice campaigns, or message delivery itself - use for managing SMS marketing subscriptions on Text2VIP only.

## Capabilities

- Create a new SMS marketing subscription when a customer opts in via a keyword
- List active subscriptions for a Text2VIP user account to drive a campaign send
- Look up a single subscription by ID to confirm opt-in status before messaging
- Update a subscription's profile details when the customer's preferences change
- Search subscriptions by attribute to build segmented audiences for targeted campaigns
- Remove a subscription when the customer opts out to stay compliant with SMS regulations

## Use cases

### Keyword Opt-In Capture

When a customer texts a keyword to a Text2VIP short code, the platform records the opt-in. Agents can mirror this in their own onboarding flow by calling PUT /{user_name}/subscription to register a subscriber programmatically with profile data captured from a web form or POS system. The subscription becomes immediately addressable from later campaign sends.

Example prompt: Call PUT /{user_name}/subscription with the customer's phone number and profile fields when they submit the loyalty signup form

### Audience Segmentation for Campaigns

Search the distribution list to build a segmented audience before a campaign send - for example, customers with a particular VIP tier or a specific home store. The search endpoint returns matching subscriptions which the agent can then iterate over for targeted messaging. This keeps blast volumes lower and engagement higher.

Example prompt: GET /{user_name}/subscription/search with attribute filters to build a VIP-tier audience before triggering an SMS campaign

### Compliant Opt-Out Handling

When a customer replies STOP or otherwise asks to be removed, the agent calls DELETE /{user_name}/subscription/{subscription_id} to remove the subscription record. This keeps the distribution list compliant with SMS marketing regulations and prevents continued sends. Pairing this with a regular search for inactive subscribers helps keep the list clean.

Example prompt: DELETE /{user_name}/subscription/{subscription_id} when an opt-out reply is received and confirm the record is gone with a follow-up GET

### AI Agent Integration via Jentic

An AI agent uses Jentic to discover Text2VIP by intent search ('add an SMS subscriber'). Jentic returns the subscription operations with their input schemas, so the agent can register, update, or remove a subscriber in a single load-and-execute step. The Text2VIP API key is held in your Jentic One instance and never enters the agent's prompt.

Example prompt: Use Jentic to search 'add an SMS subscriber', load the PUT /{user_name}/subscription schema, and execute it to register a new opt-in

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| PUT | `/{user_name}/subscription` | Create a subscription |
| GET | `/{user_name}/subscription` | List subscriptions |
| GET | `/{user_name}/subscription/{subscription_id}` | Get a subscription by ID |
| POST | `/{user_name}/subscription/{subscription_id}` | Update a subscription |
| DELETE | `/{user_name}/subscription/{subscription_id}` | Delete a subscription |
| GET | `/{user_name}/subscription/search` | Search subscriptions |

## Key resources

- **Subscriptions** — SMS marketing subscriptions scoped to a Text2VIP user account - create, list, retrieve, update, search, and delete

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 65 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 51 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 63 / 100
- **View full report:** https://jentic.com/apis/messagingchannel.com/text2vip/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Text2VIP by hand means reading its X-Apikey header scheme, threading the user name through every subscription path, and handling errors yourself. Through Jentic you install once, import Text2VIP from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Text2VIP puts the account and subscription in the URL path (/{user_name}/subscription/{subscription_id}), so a rule can pin your agent to one user's subscriptions and nothing else. You choose the operations it may call, so removing a subscriber with a DELETE is not included unless you add it.
- **Credential handling:** Your Text2VIP API key is stored once, encrypted, by your own Jentic One instance and injected into the X-Apikey header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'add an SMS subscriber' or 'find a VIP subscription', and Jentic returns the matching Text2VIP operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Programmable SMS provider for building custom marketing flows from primitives
- **MessageBird SMS** — Direct SMS gateway for transactional and marketing sends without subscription tooling
- **ClickSend** — Bulk SMS provider with a generic REST API for marketing and transactional traffic
- **Mailchimp** — Email marketing platform that pairs with SMS for multi-channel campaigns

## FAQ

### What authentication does the Text2VIP API use?

An API key in the `X-Apikey` request header, generated from the API Settings page in the Text2VIP dashboard. Through Jentic the key is stored in your Jentic One instance and injected into the header at request time, so it never enters the agent's prompt.

### How do I add a new SMS subscriber?

Call PUT /{user_name}/subscription with the subscriber's phone number and profile fields. The `{user_name}` segment is the Text2VIP account that owns the distribution list.

### Can I segment subscribers by attribute before a campaign?

Yes. Use GET /{user_name}/subscription/search with attribute filters to build a targeted audience, then iterate over the returned subscription records when triggering the campaign send.

### How do I handle an opt-out?

Call DELETE /{user_name}/subscription/{subscription_id} when the customer replies STOP or requests removal. Confirm with GET /{user_name}/subscription/{subscription_id} that the record is no longer present.

### How do I create a subscription through Jentic?

Search Jentic for `add an SMS subscriber`, load the PUT /{user_name}/subscription operation, and execute it with the customer phone and profile fields. Jentic returns the structured subscription response.

### Are there published rate limits?

The OpenAPI spec does not declare quantitative rate limits. Check the Text2VIP dashboard or contact MessagingChannel support for the limits attached to your plan before bulk imports.

### Can I limit what my agent is allowed to do with the Text2VIP API?

Yes. Because you run Jentic One yourself, your own rules decide which Text2VIP operations and credentials the agent may use. Text2VIP puts the account and subscription in the URL path (/{user_name}/subscription/{subscription_id}), so you can pin the agent to a single user's subscriptions and nothing else. You also choose the operations it may call, so a destructive DELETE of a subscriber is not available unless you explicitly add it, letting you allow read and search while withholding removal.