CustomerText

API Integrations

Connect your text platform to other systems with programmatic API access

The API provides programmatic access to your account data and features. Developers can use the API to build custom integrations, automate tasks, and connect the text messaging platform to other software -- from CRM syncing and automated message sending to custom reporting dashboards.

API Key Management

API keys are managed from Settings then API Integrations. Admin users can generate, view, and revoke API keys.

Generating an API Key

  1. Navigate to Settings then API Integrations.
  2. Click Generate API Key.
  3. Copy the key immediately and store it securely. For security purposes, the full key may not be visible again after you leave the page.
  4. Use this key in the Authorization header of your API requests.

Revoking an API Key

If a key has been compromised or is no longer needed, revoke it from the same page. Revoking a key immediately invalidates it -- any integrations using that key will stop working until updated with a new key.

Common Endpoints

The API provides access to the core features of the platform. Common operations include:

customers

  • List contacts -- Retrieve your full contact list or filter by group, status, or custom field values.
  • Create customer -- Add a new customer with phone number, name, email, and custom field data.
  • Update customer -- Modify an existing customer's information.
  • Delete customer -- Remove a customer from your account.

Groups

  • List groups -- Retrieve all standard and dynamic groups.
  • Create group -- Create a new customer group.
  • Add customers to group -- Add one or more customers to an existing group.

Messaging

  • Send message -- Send an SMS or MMS message to a specific customer or phone number.
  • Send campaign -- Trigger a campaign send to a group of customers.

Campaigns

  • List campaigns -- Retrieve campaign details and performance data.
  • Get campaign results -- Pull delivery rates, response counts, and opt-out data for a specific campaign.

Rate Limits

API requests are subject to rate limits to ensure platform stability. Rate limits apply per API key and are measured in requests per minute. If you exceed the rate limit, the API returns a 429 Too Many Requests response. Wait for the rate limit window to reset before retrying.

Best practices for rate limits:

  • Space out bulk operations rather than sending all requests simultaneously.
  • Implement retry logic with exponential backoff in your integration code.
  • Use webhooks instead of polling the API for real-time event data.

Example Use Cases

CRM customer Sync

Connect your membership management system or CRM to the platform. When a new member is added to your CRM, use the API to automatically create a matching contact record and add them to the appropriate group. This eliminates manual CSV imports and keeps your contact lists current.

Automated Message Sending

Trigger text messages from your own applications. For example, send an order confirmation when a purchase is completed, a welcome message when someone registers for an event, or a reminder when a deadline is approaching -- all through the API without logging into the platform.

customer Import Automation

Build a scheduled job that pulls new contacts from an external database and imports them into the platform nightly. Map external data fields to your contact fields to ensure all relevant information is captured.

Custom Reporting Dashboard

Pull campaign performance data, delivery statistics, and customer activity into your organization's analytics tools. Combine text messaging metrics with data from other communication channels for a unified view of engagement.

Access Permissions

Not all roles can access API settings:

  • Admin -- Full access to API key management
  • Manager -- Cannot access API keys
  • User -- Cannot access API Integrations

Tips & Best Practices

  • Keep your API keys secure. Never share them in messages, emails, or public repositories.
  • Rotate API keys periodically and revoke keys that are no longer in use.
  • Use webhooks for event-driven data flow instead of polling the API repeatedly.
  • Test your integrations in a controlled environment before deploying to production.
  • If you are not a developer, work with your technical team or integration partner to configure API connections.

Common Questions

What format does the API use?

The API uses standard REST conventions with JSON request and response bodies. Authentication is handled via an API key included in the request header.

Is there a sandbox or test environment?

customer your account team to ask about testing options. When testing, start with read-only operations (listing customers, retrieving campaigns) before performing write operations (creating customers, sending messages).