Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Textmagic Sender IDs API

Apply for and manage alphanumeric sender IDs.

Textmagic Sender IDs API is one of 11 APIs that Textmagic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sender IDs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, https://rest.textmagic.com/api/v2.

4 operations 2 paths 5 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://rest.textmagic.com/api/v2
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Textmagic Sender IDs API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-TM-Username (TmUsername). An API key is passed in the header as X-TM-Key (TmKey). By default, every request must be authenticated.

  • TmUsername — Your Textmagic account username.
  • TmKey — Your Textmagic API key, generated in the account settings.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Sender IDs 4

Apply for and manage alphanumeric sender IDs.

GET
/senderids
Get all your approved Sender IDs
getSenderIds 2 params → 200
POST
/senderids
Apply for a new Sender ID
createSenderId body → 201
GET
/senderids/{id}
Get the details of a specific Sender ID
getSenderId 1 param → 200404
DELETE
/senderids/{id}
Delete a Sender ID
deleteSenderId 1 param → 204

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are SenderId (4 properties), SenderIdList (4 properties), Error (3 properties), ResourceLink (2 properties). Each schema is shown below with its type and property counts.

SenderIdList
object
4 properties
SenderIdRequest
object
2 properties 2 required
ResourceLink
object
2 properties
SenderId
object
4 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

textmagic-sender-ids-api-openapi.yml Raw ↑

Other APIs Textmagic publishes across the network.

Textmagic Bulk API
Textmagic Chats API
Textmagic Contacts API
Textmagic Lists API
Textmagic Messages API
Textmagic Numbers API
Textmagic Replies API
Textmagic Schedules API
Textmagic Stats API
Textmagic Templates API